docs(sdk): add JSDoc to exported interfaces in packages/sdk/src/types.ts by cocosheng-g · Pull Request #26441 · google-gemini/gemini-cli

cocosheng-g · 2026-05-04T14:57:49Z

Summary

This PR adds JSDoc documentation to several public interfaces in packages/sdk/src/types.ts to improve discoverability and understanding for SDK consumers and contributors.

Details

Added comprehensive JSDoc comments to:

SystemInstructions
GeminiCliAgentOptions
AgentFilesystem
AgentShellOptions
AgentShellResult
AgentShell
SessionContext

These comments describe the purpose and usage of each interface and its properties.

Related Issues

Closes #21505

How to Validate

Inspect packages/sdk/src/types.ts to verify the added JSDoc comments.

Run lint and typecheck in the SDK package:

npm run build -w @google/gemini-cli-core
npm run lint -w @google/gemini-cli-sdk
npm run typecheck -w @google/gemini-cli-sdk

All checks should pass.

Pre-Merge Checklist

Updated relevant documentation and README (if needed)
Added/updated tests (if needed) - N/A for documentation only
Noted breaking changes (if any)
Validated on required platforms/methods:
- MacOS
  - npm run

gemini-code-assist · 2026-05-04T14:57:57Z

Summary of Changes

Hello, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on improving the maintainability and usability of the SDK by documenting key interfaces. By providing clear descriptions for types and properties, it helps contributors and consumers better understand the agent's configuration, filesystem operations, and session context.

Highlights

Documentation Improvement: Added comprehensive JSDoc comments to public interfaces in packages/sdk/src/types.ts to enhance developer experience and API discoverability.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

github-actions · 2026-05-04T15:01:17Z

Size Change: -4 B (0%)

Total Size: 33.9 MB

Filename	Size	Change
`./bundle/chunk-2NYUELT4.js`	0 B	-2.72 MB (removed)	🏆
`./bundle/chunk-45ACX5FA.js`	0 B	-3.8 kB (removed)	🏆
`./bundle/chunk-DIJJRSWM.js`	0 B	-12.5 kB (removed)	🏆
`./bundle/chunk-EDUNVPH3.js`	0 B	-657 kB (removed)	🏆
`./bundle/chunk-KNOM2IUH.js`	0 B	-3.43 kB (removed)	🏆
`./bundle/chunk-ODIOCWI6.js`	0 B	-14.7 MB (removed)	🏆
`./bundle/chunk-PPD56YFM.js`	0 B	-19.5 kB (removed)	🏆
`./bundle/chunk-XNNO7ZMD.js`	0 B	-49.2 kB (removed)	🏆
`./bundle/core-QEQR3OQG.js`	0 B	-48.4 kB (removed)	🏆
`./bundle/devtoolsService-S7H3ZTK6.js`	0 B	-28 kB (removed)	🏆
`./bundle/gemini-EOWUYHUI.js`	0 B	-582 kB (removed)	🏆
`./bundle/interactiveCli-UNDWFVBQ.js`	0 B	-1.32 MB (removed)	🏆
`./bundle/liteRtServerManager-ZAIATVPR.js`	0 B	-2.11 kB (removed)	🏆
`./bundle/oauth2-provider-NJWPAIUH.js`	0 B	-9.16 kB (removed)	🏆
`./bundle/chunk-5NSWFZXS.js`	2.72 MB	+2.72 MB (new file)	🆕
`./bundle/chunk-IAYGUHGE.js`	657 kB	+657 kB (new file)	🆕
`./bundle/chunk-MTUE7XRR.js`	49.2 kB	+49.2 kB (new file)	🆕
`./bundle/chunk-O4UUK436.js`	14.7 MB	+14.7 MB (new file)	🆕
`./bundle/chunk-QNQZKVCE.js`	3.8 kB	+3.8 kB (new file)	🆕
`./bundle/chunk-TEXNIUIG.js`	19.5 kB	+19.5 kB (new file)	🆕
`./bundle/chunk-VCWTW7VR.js`	12.5 kB	+12.5 kB (new file)	🆕
`./bundle/chunk-XJ5BXOWW.js`	3.43 kB	+3.43 kB (new file)	🆕
`./bundle/core-BEXPAD4I.js`	48.4 kB	+48.4 kB (new file)	🆕
`./bundle/devtoolsService-MXXODOAN.js`	28 kB	+28 kB (new file)	🆕
`./bundle/gemini-AGRWF745.js`	582 kB	+582 kB (new file)	🆕
`./bundle/interactiveCli-IOQ65LOZ.js`	1.32 MB	+1.32 MB (new file)	🆕
`./bundle/liteRtServerManager-XISQRRBF.js`	2.11 kB	+2.11 kB (new file)	🆕
`./bundle/oauth2-provider-VGKVUPJR.js`	9.16 kB	+9.16 kB (new file)	🆕

ℹ️ View Unchanged

Filename	Size	Change
`./bundle/bundled/third_party/index.js`	8 MB	0 B
`./bundle/chunk-34MYV7JD.js`	2.45 kB	0 B
`./bundle/chunk-5AUYMPVF.js`	858 B	0 B
`./bundle/chunk-5PS3AYFU.js`	1.18 kB	0 B
`./bundle/chunk-664ZODQF.js`	124 kB	0 B
`./bundle/chunk-DAHVX5MI.js`	206 kB	0 B
`./bundle/chunk-DD4MWEAB.js`	1.97 MB	0 B
`./bundle/chunk-IUUIT4SU.js`	56.5 kB	0 B
`./bundle/chunk-RJTRUG2J.js`	39.8 kB	0 B
`./bundle/cleanup-VKDR6L4H.js`	0 B	-932 B (removed)	🏆
`./bundle/devtools-36NN55EP.js`	696 kB	0 B
`./bundle/dist-T73EYRDX.js`	356 B	0 B
`./bundle/events-XB7DADIJ.js`	418 B	0 B
`./bundle/examples/hooks/scripts/on-start.js`	188 B	0 B
`./bundle/examples/mcp-server/example.js`	1.43 kB	0 B
`./bundle/gemini.js`	5.1 kB	0 B
`./bundle/getMachineId-bsd-TXG52NKR.js`	1.55 kB	0 B
`./bundle/getMachineId-darwin-7OE4DDZ6.js`	1.55 kB	0 B
`./bundle/getMachineId-linux-SHIFKOOX.js`	1.34 kB	0 B
`./bundle/getMachineId-unsupported-5U5DOEYY.js`	1.06 kB	0 B
`./bundle/getMachineId-win-6KLLGOI4.js`	1.72 kB	0 B
`./bundle/memoryDiscovery-HRURE3F3.js`	980 B	0 B
`./bundle/multipart-parser-KPBZEGQU.js`	11.7 kB	0 B
`./bundle/node_modules/@google/gemini-cli-devtools/dist/client/main.js`	222 kB	0 B
`./bundle/node_modules/@google/gemini-cli-devtools/dist/src/_client-assets.js`	229 kB	0 B
`./bundle/node_modules/@google/gemini-cli-devtools/dist/src/index.js`	13.4 kB	0 B
`./bundle/node_modules/@google/gemini-cli-devtools/dist/src/types.js`	132 B	0 B
`./bundle/sandbox-macos-permissive-open.sb`	890 B	0 B
`./bundle/sandbox-macos-permissive-proxied.sb`	1.31 kB	0 B
`./bundle/sandbox-macos-restrictive-open.sb`	3.36 kB	0 B
`./bundle/sandbox-macos-restrictive-proxied.sb`	3.56 kB	0 B
`./bundle/sandbox-macos-strict-open.sb`	4.82 kB	0 B
`./bundle/sandbox-macos-strict-proxied.sb`	5.02 kB	0 B
`./bundle/src-QVCVGIUX.js`	47 kB	0 B
`./bundle/start-IBU24OCT.js`	0 B	-652 B (removed)	🏆
`./bundle/tree-sitter-7U6MW5PS.js`	274 kB	0 B
`./bundle/tree-sitter-bash-34ZGLXVX.js`	1.84 MB	0 B
`./bundle/cleanup-7KCQXQRJ.js`	932 B	+932 B (new file)	🆕
`./bundle/start-BHPZ33WT.js`	652 B	+652 B (new file)	🆕

_{compressed-size-action}

gemini-code-assist

Code Review

This pull request adds JSDoc documentation to the SDK's type definitions and interfaces to improve code clarity. The review feedback identifies several security risks, including prompt injection, command injection, and path traversal, and suggests enhancing the documentation with explicit security warnings and sanitization requirements for sensitive components like SystemInstructions, AgentShell, and AgentFilesystem.

….ts (google-gemini#26441)

docs(sdk): add JSDoc to exported interfaces in packages/sdk/src/types.ts

0dc7ac0

cocosheng-g requested a review from a team as a code owner May 4, 2026 14:57

Adib234 approved these changes May 4, 2026

View reviewed changes

cocosheng-g enabled auto-merge May 4, 2026 15:01

gemini-code-assist Bot reviewed May 4, 2026

View reviewed changes

Comment thread packages/sdk/src/types.ts

Comment thread packages/sdk/src/types.ts Outdated

Comment thread packages/sdk/src/types.ts Outdated

Comment thread packages/sdk/src/types.ts Outdated

Comment thread packages/sdk/src/types.ts

cocosheng-g disabled auto-merge May 4, 2026 15:06

docs(sdk): add security warnings to JSDoc in types.ts

8958313

cocosheng-g enabled auto-merge May 4, 2026 15:09

cocosheng-g added this pull request to the merge queue May 4, 2026

gemini-cli Bot added area/core Issues related to User Interface, OS Support, Core Functionality area/agent Issues related to Core Agent, Tools, Memory, Sub-Agents, Hooks, Agent Quality area/documentation Gemini CLI documentation tasks and issues labels May 4, 2026

github-merge-queue Bot removed this pull request from the merge queue due to failed status checks May 4, 2026

cocosheng-g enabled auto-merge May 4, 2026 15:44

cocosheng-g disabled auto-merge May 4, 2026 15:47

Merged via the queue into main with commit 4fa2c95 May 4, 2026
27 checks passed

cocosheng-g deleted the issue-21505 branch May 4, 2026 16:18

TirthNaik-99 pushed a commit to TirthNaik-99/gemini-cli that referenced this pull request May 4, 2026

docs(sdk): add JSDoc to exported interfaces in packages/sdk/src/types…

6b78744

….ts (google-gemini#26441)

kimjune01 pushed a commit to kimjune01/gemini-cli-claude that referenced this pull request May 6, 2026

docs(sdk): add JSDoc to exported interfaces in packages/sdk/src/types…

86090e5

….ts (google-gemini#26441)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(sdk): add JSDoc to exported interfaces in packages/sdk/src/types.ts#26441

docs(sdk): add JSDoc to exported interfaces in packages/sdk/src/types.ts#26441
cocosheng-g merged 2 commits intomainfrom
issue-21505

cocosheng-g commented May 4, 2026

Uh oh!

gemini-code-assist Bot commented May 4, 2026

Uh oh!

github-actions Bot commented May 4, 2026 •

edited

Loading

Uh oh!

gemini-code-assist Bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

cocosheng-g commented May 4, 2026

Summary

Details

Related Issues

How to Validate

Pre-Merge Checklist

Uh oh!

gemini-code-assist Bot commented May 4, 2026

Summary of Changes

Highlights

Footnotes

Uh oh!

github-actions Bot commented May 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

github-actions Bot commented May 4, 2026 •

edited

Loading