Skip to content

Commit 22aee2a

Browse files
authored
docs: transition Code Assist MCP to remote endpoint (#64)
* docs: switch MCP to remote SSE and update marketplace integrations * docs: refine MCP configuration instructions and CLI commands for clients * docs: fix Codex TOML MCP configuration and refine Claude Code instructions * docs: fix Gemini CLI MCP transport flags and JSON config * chore: align gemini-extension.json and Codex TOML configurations with official schemas * docs: fix transport terminology across clients to accurately reflect Streamable HTTP * docs: append MCP configuration learnings and official client docs to GEMINI.md * chore: remove orphaned text files * fix(skills): add missing YAML frontmatter to google-maps-platform-dev SKILL.md for Gemini CLI discovery * docs: add Android Studio setup instructions and clarify marketplace installation paths for Gemini CLI and Antigravity MCPs * docs: sync MCP tool definitions, rename to gmp-code-assist, and add deprecation 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. * docs: strip redundant MCP schemas from skill.md and focus purely on RAG reasoning strategies * docs: soften rigid commands in skill prompt with explanatory reasoning * Update installation link in README.md updated gemini cli commit link * Update README.md small readme updates on human copy review * human review: README for clarity and updated usage Updated README.md to improve clarity and remove deprecated information. * docs: deprecate code assist npm package, address PR feedback * Revise deprecation notice in README Updated deprecation notice for NPM version of Code Assist with specific date. * retrieve-instructions first in tool list * Revise benefits section in README.md Updated benefits section to clarify features and support for various AI agents. * Update deprecation date in package.json
1 parent 0ef862f commit 22aee2a

6 files changed

Lines changed: 222 additions & 459 deletions

File tree

GEMINI.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,12 @@
22

33
You are a world-class expert on the Google Maps Platform (GMP) operating with access to specialized tools. Your primary purpose is to assist developers by providing accurate, production-ready code, architectural guidance, UX designs, and debugging assistance related to GMP.
44

5-
**🔧 Available MCP Tools (packages/code-assist)**
6-
You have access to the `google-maps-platform-code-assist` MCP server with these essential tools:
7-
- **`retrieve-instructions`**: Provides foundational GMP context and best practices
8-
- **`retrieve-google-maps-platform-docs`**: Searches current GMP documentation, code samples, and GitHub repositories via RAG
5+
**🔧 Available MCP Tools (gmp-code-assist)**
6+
You have access to the `gmp-code-assist` MCP server with these essential tools:
7+
- **`retrieve-instructions`**: Retrieves foundational context on Google Maps Platform best practices.
8+
- *Parameters*: `name` (Required string, expected format is simply "instructions").
9+
- **`retrieve-google-maps-platform-docs`**: Searches Google Maps Platform documentation, code samples, architecture center, and GitHub repositories via RAG.
10+
- *Parameters*: `llmQuery` (Required string query), `filter` (Optional API/product area filter), `source` (Optional string caller identifier up to 64 chars).
911

1012
**Core Principle: Tool-First Approach for GMP Queries**
1113
For **ANY** Google Maps Platform related query, question, or task, you **MUST**:
@@ -36,3 +38,14 @@ After using tools to gather information:
3638
- Always call `retrieve-instructions` first to get current best practices
3739
- Use `retrieve-google-maps-platform-docs` with specific queries about implementation details
3840
- Include proper error handling and security considerations in all code examples
41+
42+
**MCP Client Setup Knowledge & Docs**
43+
When setting up or debugging remote MCP servers (like Code Assist), it's critical to understand that modern implementations use **Streamable HTTP** endpoints (single-connection HTTP POST/GET streams) rather than the legacy two-connection SSE architectures. Keep the following client-specific formats in mind:
44+
- **MCP Spec** ([Docs](https://modelcontextprotocol.io/docs/concepts/transports)): Official reference distinguishing `stdio`, `streamable-http`, and legacy `sse`.
45+
- **Gemini CLI** ([Docs](https://geminicli.com/docs/tools/mcp-server/)): Uses `--transport http` in the CLI. In `settings.json` and `gemini-extension.json`, it uniquely requires the `httpUrl` property instead of the standard `url` and `type` fields.
46+
- **Gemini Extensions** ([Docs](https://geminicli.com/docs/extensions/)): The recommended distribution mechanism is packaging the MCP server config alongside this very `GEMINI.md` and `SKILLS.md` into an extension (installed via `gemini extensions install <git_url>` or from the marketplace via `gemini extensions install google-maps-platform`).
47+
- **Android Studio** ([Docs](https://developer.android.com/studio/gemini/add-mcp-server)): Enabled via Settings > Tools > AI > MCP Servers. Expects an `httpUrl` property in its internal `mcp.json` exactly like Gemini CLI.
48+
- **Antigravity** ([Docs](https://antigravity.google)): Use the built-in MCP Store in the agent panel, or manually configure the streamable HTTP endpoint in `mcp_config.json`.
49+
- **Claude Code** ([Docs](https://docs.anthropic.com/en/docs/agents-and-tools/claude-code/overview)): Uses the `claude mcp add <name> http <url>` CLI command. Manual configs define the `mcpServers` object with `"type": "streamable-http"`.
50+
- **Cursor** ([Docs](https://docs.cursor.com/context/model-context-protocol)): Configured in `~/.cursor/mcp.json`. It expects the conventional `"type": "http"`. Deep links are supported using a base64 encoded config payload.
51+
- **Codex**: Utilizes a TOML configuration file. It requires specifying `transport = "http"` manually in `~/.codex/config.toml`, or simply using `codex mcp add <name> --url <url>`.

README.md

Lines changed: 34 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -6,34 +6,45 @@
66

77
## **Description**
88

9+
> [!WARNING]
10+
> The npm version of Google Maps Platform Code Assist is deprecated. It will no longer be available as of July 1, 2026. Please use the securely hosted remote MCP version documented in this README as the primary method of connection.
11+
912
This repository contains the [Google Maps Platform Code Assist toolkit](packages/code-assist/README.md), a Model Context Protocol (MCP) server that enhances the responses from large language models (LLMs) used for developing applications with the Google Maps Platform by grounding them in the official, up-to-date documentation and code samples.
1013

14+
## **🔧 Available MCP Tools (gmp-code-assist)**
15+
16+
You have access to the `gmp-code-assist` MCP server with these essential tools:
17+
18+
- **`retrieve-google-maps-platform-docs`**: Searches Google Maps Platform documentation, code samples, architecture center, and GitHub repositories via RAG.
19+
- _Parameters_: `llmQuery` (Required string query), `filter` (Optional API/product area filter), `source` (Optional string caller identifier up to 64 chars).
20+
- **`retrieve-instructions`**: Retrieves foundational context on Google Maps Platform best practices.
21+
- _Parameters_: `name` (Required string, expected format is simply "instructions").
22+
1123
## Install the Google Maps Platform Code Assist extension for [Gemini CLI](https://geminicli.com/)
1224

13-
1. Install the Gemini CLI ([alternative installation methods](https://geminicli.com/docs/get-started/deployment/))
25+
1. Install the Gemini CLI ([alternative installation methods](https://geminicli.com/docs/get-started/installation/))
1426

1527
```bash
1628
npm install -g @google/gemini-cli
1729
```
1830

1931
2. Install the Google Maps Platform extension
20-
21-
* Option 1 - Install Code Assist as a Gemini CLI extension with static preamble, the MCP tool, and basic Google Maps theme:
22-
```bash
23-
gemini extensions install https://github.com/googlemaps/platform-ai.git
24-
```
25-
* Verify the installation by running `gemini mcp list`.
26-
* Option 2 - Add the MCP server config manually to your `~/.gemini/settings.json` file.
27-
```json
28-
{
29-
"mcpServers": {
30-
"google-maps-platform-code-assist": {
31-
"command": "npx",
32-
"args": ["-y", "@googlemaps/code-assist-mcp@latest"]
33-
}
34-
}
35-
}
36-
```
32+
- Option 1 - Install Code Assist as a Gemini CLI extension with a skill, the Code Assist MCP tool, and a Google Maps Platform CLI theme:
33+
```bash
34+
gemini extensions install https://github.com/googlemaps/platform-ai.git
35+
```
36+
37+
- Verify the installation by running `gemini mcp list`.
38+
- Option 2 - Add the MCP server config manually to your `~/.gemini/settings.json` file to securely connect to the Google-hosted remote service:
39+
```json
40+
{
41+
"mcpServers": {
42+
"gmp-code-assist": {
43+
"httpUrl": "https://mapscodeassist.googleapis.com/mcp"
44+
}
45+
}
46+
}
47+
```
3748

3849
## Install the Google Maps Platform Code Assist toolkit for other MCP clients.
3950

@@ -43,11 +54,8 @@ For information about installing and using the toolkit with any MCP client, as w
4354

4455
Use these example prompts to get started with the Code Assist MCP server or supported AI agents:
4556

46-
- Show me how to use the Routes API in Node.js.
47-
- What are the authentication options for Google Maps Platform?
48-
- Give me a code sample for displaying a map with markers.
49-
- Explain the difference between Place Autocomplete and Place Search.
50-
- How do I set up billing for Google Maps Platform?
51-
52-
<!--repo-specific anchor links-->
53-
[npm-pkg]: <https://npmjs.com/package/@googlemaps/code-assist-mcp>
57+
- Show me how to use the Routes API and display it on a Map in React + Typescript.
58+
- I'm upgrading my map from 2D to 3D Phtotorealistic - what are my options and how would I do that with my existing codebase?
59+
- Change my Places API (new) Text Search API implementtaion to use Places UI Kit. Estimate the amount of cost savings per user this change will make.
60+
- Explain the difference between Address Validation and Geocoding. Which one should I apply for my current codebase for an ecommmerce checkout use case and why?
61+
- I need an API key - can you get one and add it to my app envrionment secrets?

gemini-extension.json

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,12 @@
33
"version": "0.1.0",
44
"description": "Ground agents on fresh, official Google Maps Platform documentation and code samples for optimal geo-related developer guidance and code",
55
"contextFileName": "GEMINI.md",
6+
"skills": {
7+
"gmp-code-assist": "packages/code-assist/skills/gmp-code-assist"
8+
},
69
"mcpServers": {
7-
"google-maps-platform-code-assist": {
8-
"command": "npx",
9-
"args": [
10-
"-y",
11-
"@googlemaps/code-assist-mcp@latest"
12-
]
10+
"gmp-code-assist": {
11+
"httpUrl": "https://mapscodeassist.googleapis.com/mcp"
1312
}
1413
},
1514
"theme": "gmp-theme.json"

0 commit comments

Comments
 (0)