Skip to content

docs: transition Code Assist MCP to remote endpoint#64

Open
ryanbaumann wants to merge 21 commits into
mainfrom
update-mcp-readme
Open

docs: transition Code Assist MCP to remote endpoint#64
ryanbaumann wants to merge 21 commits into
mainfrom
update-mcp-readme

Conversation

@ryanbaumann
Copy link
Copy Markdown
Collaborator

@ryanbaumann ryanbaumann commented Mar 6, 2026

Note: This PR is dependent on another PR that will deprecate all of the old self-hosted version code on NPM. We have added a notice in the README that the NPM version will be deprecated and will no longer be available as of [XX date - to be completed]. Please use the securely hosted remote version as the primary connection method.

⚠️ DO NOT MERGE until the updated Code Assist MCP server is successfully launched and deployed.

This PR updates the Code Assist MCP server documentation and configurations to strictly support the modern remote Streamable HTTP endpoint (https://mapscodeassist.googleapis.com/mcp) while informing developers that the old NPM version is depricated.

Key Changes

  • Transports Corrected: Ensured all client configurations use http / streamable-http / httpUrl parameters rather than legacy sse.
  • Removed Local Setup: Stripped all references to local npm installs, Cloud Run deployments, and legacy clients.
  • Client Configuration: Added config how-to's for Gemini CLI, Antigravity, Claude Code, Cursor, Codex, and Antigravity.
    • Standardized Gemini CLI instructions to use httpUrl
    • Added CLI-first approaches for Claude Code (claude mcp add) and Codex (codex mcp add).
    • Added TOML fallback configurations for Codex.
  • Gemini CLI Extension Marketplace: Updated gemini-extension.json to use a "skill" vs. a "GEMINI.md" file, renamed the skill to gmp-code-assist, and bundled the new skill.md with the gemini extension.
  • Set server name to gmp-code-assist across the readme to prevent "too long of name" errors on certain clients.

…nstallation paths for Gemini CLI and Antigravity MCPs
…eprecation notice

Note: This PR is dependent on another upcoming PR that will deprecate all of the old self-hosted version code on NPM. We have added a notice in the README that the NPM version will be deprecated and will no longer be available as of [XX date - to be completed]. Users should use the securely hosted remote version as the primary connection method, as referenced in this README.

- Renamed skill and MCP server references to strictly use 'gmp-code-assist'
- Updated MCP tools descriptions in READMEs to perfectly match the 'retrieve-google-maps-platform-docs' and 'retrieve-instructions' endpoints.
- Removed arbitrary 'vibecoding' language for safer enterprise tone.
- Ensured total consistency across root README, package README, GEMINI.md, and skill specs.
@ryanbaumann
Copy link
Copy Markdown
Collaborator Author

Ready for a first 👓 @caio1985

Comment thread packages/code-assist/README.md Outdated
2. **`retrieve-google-maps-platform-docs`**: The primary tool. It takes a natural language query and submits it to a hosted Retrieval Augmented Generation (RAG) engine. The RAG engine searches fresh versions of official Google Maps Platform documentation, tutorials, and code samples, returning relevant context to the AI to generate an accurate response.
<!-- [END maps_Tools] -->
1. **`retrieve-google-maps-platform-docs`**: Searches Google Maps Platform documentation, code samples, architecture center, and GitHub repositories via RAG.
- *Parameters*: `llmQuery` (Required string query), `filter` (Optional API/product area filter), `source` (Optional string caller identifier up to 64 chars).
Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

TBD: should we add a source parameter by default to the docs on how to install?

Comment thread packages/code-assist/README.md Outdated
- **HTTP `/health` Endpoint**: A simple `GET` request to this endpoint (e.g., `https://your-service-url/health`) will return a `200 OK` status with a JSON payload containing the server status, number of active sessions, and a timestamp if the server is running. This is used for infrastructure-level health checks.
- **MCP `ping` Utility**: This is different from the in-protocol `ping` utility defined by the MCP specification. The `ping` utility is a JSON-RPC request sent *after* a session is established to check the liveness of the *protocol connection*, whereas the `/health` endpoint checks the liveness of the *HTTP server* itself.
> [!WARNING]
> We will be deprecating the version of this package on NPM, and it will no longer be available as of [XX date - to be completed]. Please use the securely hosted remote version as the primary method of connection, as documented below.
Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

to update: Date of deprication

Comment thread gemini-extension.json
updated gemini cli commit link
small readme updates on human copy review
Updated README.md to improve clarity and remove deprecated information.
Comment thread packages/code-assist/README.md
Comment thread packages/code-assist/README.md Outdated
@caio1985
Copy link
Copy Markdown
Member

@ryanbaumann let's start this deprecation if possible as I'm unable to call npm deprecate :(

There's just one comment from Angela that needs to be addressed.

@ryanbaumann
Copy link
Copy Markdown
Collaborator Author

ryanbaumann commented Apr 23, 2026 via email

@ryanbaumann
Copy link
Copy Markdown
Collaborator Author

@caio1985 @wangela

I've just pushed an update to address the feedback:

  1. Tool Order: Reordered the tools list in the README so retrieve-instructions is correctly listed first.
  2. Deprecation Language: Updated the README and package.json to explicitly state the package is deprecated (rather than "will
    be").
  3. Marked this PR "ready for review" from Draft

Final decision needed:

  • Decommission Date: To address Angela's feedback, I added a placeholder date of June 1, 2026 as the official turn-down date in the README and package.json deprecation warnings. What date do we want to use here?

Note: I have not yet run the npm deprecate command to push the deprecation notice to the live NPM registry. I am holding off on running that until we confirm the final decommission date and merge this PR.

@ryanbaumann ryanbaumann marked this pull request as ready for review April 24, 2026 23:54
@snippet-bot
Copy link
Copy Markdown

snippet-bot Bot commented Apr 24, 2026

Here is the summary of changes.

You are about to delete 3 region tags.

This comment is generated by snippet-bot.
If you find problems with this result, please file an issue at:
https://github.com/googleapis/repo-automation-bots/issues.
To update this comment, add snippet-bot:force-run label or use the checkbox below:

  • Refresh this comment

Copy link
Copy Markdown
Member

@wangela wangela left a comment

Choose a reason for hiding this comment

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

Overall, 30 days is very short for a deprecation window. Can we support for at least 60 days (July 1, 2026)?

Comment thread README.md Outdated
Comment thread README.md
Comment thread packages/code-assist/README.md Outdated
Comment thread packages/code-assist/package.json Outdated
Comment thread packages/code-assist/README.md
Updated deprecation notice for NPM version of Code Assist with specific date.
Updated benefits section to clarify features and support for various AI agents.
@ryanbaumann
Copy link
Copy Markdown
Collaborator Author

Thanks @wangela - comments addressed. Once LGTM , I will move to merge this PR and mark the code Assist npm package deprecated cc/ @caio1985

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants