Skip to content

docs: add client configuration for Claude Desktop, Gemini CLI, Grok, ChatGPT, VS Code, and Windsurf - #70

Open
Totti0135 wants to merge 1 commit into
xyTom:mainfrom
Totti0135:docs/extend-client-coverage
Open

docs: add client configuration for Claude Desktop, Gemini CLI, Grok, ChatGPT, VS Code, and Windsurf#70
Totti0135 wants to merge 1 commit into
xyTom:mainfrom
Totti0135:docs/extend-client-coverage

Conversation

@Totti0135

@Totti0135 Totti0135 commented Aug 15, 2026

Copy link
Copy Markdown

Summary

docs/mcp-client-config.md covered only Codex, Claude Code, and Cursor. This PR extends it to the remaining common MCP hosts, with each host's configuration format verified against its current vendor documentation. Server behavior is unchanged — every path already works over stdio or Streamable HTTP; this closes a documentation gap only.

Local stdio clients

  • Claude Desktopclaude_desktop_config.json location per platform
  • Claude Code — adds the claude mcp add one-liner alongside the existing JSON
  • VS Code (GitHub Copilot).vscode/mcp.json with the servers / type: "stdio" shape, noting the type: "http" variant for the local HTTP server
  • Windsurf~/.codeium/windsurf/mcp_config.json
  • Gemini CLIgemini mcp add for stdio and --transport http, ~/.gemini/settings.json vs .gemini/settings.json scopes, and the underscore-in-server-name caveat (tool names are derived from it)

Cloud connector clients (tunnel + auth)

  • ChatGPT (developer mode) — cloud-only, needs the HTTPS tunnel; connectors offer OAuth or no authentication, with no static bearer header to enter, so the OAuth tunnel is the documented path. Includes the manual-form fallback (authorize/token URLs, pre-registered client via CODING_TOOLS_MCP_OAUTH_CLIENT_*)
  • Grok — grok.com custom connector completes OAuth in a popup; the xAI API's remote MCP tools take server_url + authorization (static bearer tunnel) instead

README updates (en + zh-CN)

  • Client lists in the intro and quickstart extended to match
  • The remote-access bullet now mentions ChatGPT/Grok connector setup

Test plan

  • python -m tests.compliance.runner --suite docs-required — 4/4 OK
  • Local HTTP smoke: initialize (2025-11-25) + tools/list → 18 tools on http://127.0.0.1:8765/mcp
  • Local stdio smoke: initialize → notifications/initializedtools/call read_fileisError: false, structuredContent present
  • Manual verification in each GUI client (maintainers/community welcome): Claude Desktop JSON, claude mcp add, gemini mcp add (stdio + http), VS Code .vscode/mcp.json
  • Live tunnel + OAuth against a ChatGPT developer-mode connector and a grok.com custom connector

…ChatGPT, VS Code, and Windsurf

The client configuration page covered Codex, Claude Code, and Cursor only.
Add per-client walkthroughs for the remaining common MCP hosts: local stdio
clients (Claude Desktop, VS Code, Windsurf, Gemini CLI) and cloud connector
clients (ChatGPT developer mode, Grok), using each host's verified config
format. Extend the client lists in both READMEs accordingly.
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.

1 participant