Skip to content

ACP integration documents#22254

Merged
g-samroberts merged 15 commits intomainfrom
acp-docs
Mar 27, 2026
Merged

ACP integration documents#22254
g-samroberts merged 15 commits intomainfrom
acp-docs

Conversation

@g-samroberts
Copy link
Copy Markdown
Contributor

Summary

ACP integration documents: Update existing IDE integration documents, and give details about ACP mode in Gemini CLI.

Fixes: google-gemini/maintainers-gemini-cli#1427

Pre-Merge Checklist

  • Updated relevant documentation and README (if needed)
  • Added/updated tests (if needed)
  • Noted breaking changes (if any)
  • Validated on required platforms/methods:
    • MacOS
      • npm run
      • npx
      • Docker
      • Podman
      • Seatbelt
    • Windows
      • npm run
      • npx
      • Docker
    • Linux
      • npm run
      • npx
      • Docker

@g-samroberts g-samroberts requested review from a team as code owners March 13, 2026 01:07
@gemini-cli
Copy link
Copy Markdown
Contributor

gemini-cli bot commented Mar 13, 2026

Hi @g-samroberts, thank you so much for your contribution to Gemini CLI! We really appreciate the time and effort you've put into this.

We're making some updates to our contribution process to improve how we track and review changes. Please take a moment to review our recent discussion post: Improving Our Contribution Process & Introducing New Guidelines.

Key Update: Starting January 26, 2026, the Gemini CLI project will require all pull requests to be associated with an existing issue. Any pull requests not linked to an issue by that date will be automatically closed.

Thank you for your understanding and for being a part of our community!

@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! 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 enhances the Gemini CLI documentation by introducing a dedicated guide for the Agent Communication Protocol (ACP) mode and integrating this information into the broader IDE integration documentation. The changes aim to provide clearer instructions and a deeper understanding of how Gemini CLI interacts with various development environments, particularly for programmatic control and advanced integrations.

Highlights

  • New ACP Mode Documentation: A new comprehensive document has been added detailing the Agent Communication Protocol (ACP) mode for Gemini CLI, explaining its architecture, usage, and extensibility via Model Context Protocol (MCP).
  • Updated IDE Integration Guide: The existing IDE integration documentation has been significantly updated to clearly differentiate between the VS Code Companion Extension and ACP-based integrations, providing more details on how ACP facilitates integration with IDEs like JetBrains and Zed.
  • Sidebar Navigation Update: The documentation sidebar has been updated to include a direct link to the newly added ACP mode documentation, improving discoverability.
Changelog
  • docs/cli/acp-mode.md
    • Added a new document explaining the Agent Communication Protocol (ACP) mode, its architecture, communication methods (JSON-RPC over stdio), and extensibility through the Model Context Protocol (MCP).
    • Detailed core methods, session control, and file system proxy features within ACP.
    • Included sections on debugging and telemetry for ACP mode.
  • docs/ide-integration/index.md
    • Updated the introduction to outline two primary integration methods: VS Code Companion Extension and Agent Communication Protocol (ACP).
    • Restructured the document to separate details for the VS Code Companion Extension and introduce a new section for ACP integration.
    • Added information about the ACP Agent Registry and specific IDE integrations for JetBrains and Zed.
    • Revised subheadings for consistency (e.g., 'Features' to '### Features', 'Installation and setup' to '### Installation and Setup').
    • Added a new troubleshooting section specifically for ACP integration errors, directing users to the new ACP mode document.
  • docs/sidebar.json
    • Added a new entry for 'ACP mode' under the CLI documentation section, linking to the new docs/cli/acp-mode.md file.
Activity
  • The pull request addresses issue google-gemini/maintainers-gemini-cli#1427.
  • The author has marked the relevant documentation and README as updated in the pre-merge checklist.
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.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. 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.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request adds new documentation for the ACP (Agent Communication Protocol) mode and updates the existing IDE integration documentation to include details about ACP. The changes are well-structured and improve the documentation by providing a clear overview of different integration methods. I've found two broken/incorrect links in the updated ide-integration/index.md file that should be fixed to ensure users can access the correct information.

Note: Security Review has been skipped due to the limited scope of the PR.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 13, 2026

Size Change: -4 B (0%)

Total Size: 26.3 MB

Filename Size Change
./bundle/chunk-A3AK4N7M.js 0 B -3.64 MB (removed) 🏆
./bundle/chunk-THS55U7M.js 0 B -14.7 MB (removed) 🏆
./bundle/core-6XMGXQO7.js 0 B -43.8 kB (removed) 🏆
./bundle/devtoolsService-3VLQNTOH.js 0 B -27.7 kB (removed) 🏆
./bundle/interactiveCli-2UNONA4B.js 0 B -1.63 MB (removed) 🏆
./bundle/oauth2-provider-B4L35HFU.js 0 B -9.16 kB (removed) 🏆
./bundle/chunk-32NMVQGO.js 3.64 MB +3.64 MB (new file) 🆕
./bundle/chunk-QQYCTCH3.js 14.7 MB +14.7 MB (new file) 🆕
./bundle/core-QCVK5H3M.js 43.8 kB +43.8 kB (new file) 🆕
./bundle/devtoolsService-WNHBLFUS.js 27.7 kB +27.7 kB (new file) 🆕
./bundle/interactiveCli-JYHDZSRM.js 1.63 MB +1.63 MB (new file) 🆕
./bundle/oauth2-provider-YJBTGPAL.js 9.16 kB +9.16 kB (new file) 🆕
ℹ️ View Unchanged
Filename Size
./bundle/chunk-34MYV7JD.js 2.45 kB
./bundle/chunk-5AUYMPVF.js 858 B
./bundle/chunk-664ZODQF.js 124 kB
./bundle/chunk-DAHVX5MI.js 206 kB
./bundle/chunk-IUUIT4SU.js 56.5 kB
./bundle/chunk-RJDXJELZ.js 1.96 MB
./bundle/chunk-RJTRUG2J.js 39.8 kB
./bundle/devtools-36NN55EP.js 696 kB
./bundle/dist-T73EYRDX.js 356 B
./bundle/gemini.js 529 kB
./bundle/getMachineId-bsd-TXG52NKR.js 1.55 kB
./bundle/getMachineId-darwin-7OE4DDZ6.js 1.55 kB
./bundle/getMachineId-linux-SHIFKOOX.js 1.34 kB
./bundle/getMachineId-unsupported-5U5DOEYY.js 1.06 kB
./bundle/getMachineId-win-6KLLGOI4.js 1.72 kB
./bundle/memoryDiscovery-5JAQO7MA.js 922 B
./bundle/multipart-parser-KPBZEGQU.js 11.7 kB
./bundle/node_modules/@google/gemini-cli-devtools/dist/client/main.js 221 kB
./bundle/node_modules/@google/gemini-cli-devtools/dist/src/_client-assets.js 227 kB
./bundle/node_modules/@google/gemini-cli-devtools/dist/src/index.js 11.5 kB
./bundle/node_modules/@google/gemini-cli-devtools/dist/src/types.js 132 B
./bundle/sandbox-macos-permissive-open.sb 890 B
./bundle/sandbox-macos-permissive-proxied.sb 1.31 kB
./bundle/sandbox-macos-restrictive-open.sb 3.36 kB
./bundle/sandbox-macos-restrictive-proxied.sb 3.56 kB
./bundle/sandbox-macos-strict-open.sb 4.82 kB
./bundle/sandbox-macos-strict-proxied.sb 5.02 kB
./bundle/src-QVCVGIUX.js 47 kB
./bundle/tree-sitter-7U6MW5PS.js 274 kB
./bundle/tree-sitter-bash-34ZGLXVX.js 1.84 MB

compressed-size-action

@gemini-cli gemini-cli bot added the status/need-issue Pull requests that need to have an associated issue. label Mar 13, 2026
@sripasg sripasg requested a review from nicholaskang-us March 13, 2026 05:11
g-samroberts and others added 3 commits March 13, 2026 11:20
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Remove experimental flag, as it's deprecated.
@g-samroberts g-samroberts added area/documentation Gemini CLI documentation tasks and issues and removed status/need-issue Pull requests that need to have an associated issue. labels Mar 18, 2026
@gemini-cli gemini-cli bot added the status/need-issue Pull requests that need to have an associated issue. label Mar 18, 2026
@g-samroberts g-samroberts self-assigned this Mar 18, 2026
Copy link
Copy Markdown
Contributor

@nmcnamara-eng nmcnamara-eng left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added a bunch of comments / suggested edits. What do you think?

g-samroberts and others added 8 commits March 23, 2026 19:04
Co-authored-by: nmcnamara-eng <118702206+nmcnamara-eng@users.noreply.github.com>
Co-authored-by: nmcnamara-eng <118702206+nmcnamara-eng@users.noreply.github.com>
Co-authored-by: nmcnamara-eng <118702206+nmcnamara-eng@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

@jkcinouye jkcinouye left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@g-samroberts g-samroberts added this pull request to the merge queue Mar 27, 2026
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Mar 27, 2026
@g-samroberts g-samroberts added this pull request to the merge queue Mar 27, 2026
Merged via the queue into main with commit 6f92642 Mar 27, 2026
27 checks passed
@g-samroberts g-samroberts deleted the acp-docs branch March 27, 2026 02:25
danzaharia1 pushed a commit that referenced this pull request Mar 27, 2026
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: nmcnamara-eng <118702206+nmcnamara-eng@users.noreply.github.com>
ProthamD pushed a commit to ProthamD/gemini-cli that referenced this pull request Mar 29, 2026
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: nmcnamara-eng <118702206+nmcnamara-eng@users.noreply.github.com>
afanty2021 pushed a commit to afanty2021/gemini-cli that referenced this pull request Apr 4, 2026
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: nmcnamara-eng <118702206+nmcnamara-eng@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/documentation Gemini CLI documentation tasks and issues status/need-issue Pull requests that need to have an associated issue.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants