Skip to content

(docs): expand MCP client setup instructions#74

Merged
ChiragAgg5k merged 3 commits into
mainfrom
docs/mcp-client-setup
Jul 9, 2026
Merged

(docs): expand MCP client setup instructions#74
ChiragAgg5k merged 3 commits into
mainfrom
docs/mcp-client-setup

Conversation

@ChiragAgg5k

Copy link
Copy Markdown
Member

What

Expands the "Connect your client" section of the README:

  • Claude Code: added the /mcp authenticate step after claude mcp add.
  • Claude Desktop: config path updated to Settings → Developer → Local MCP servers → Edit Config (with screenshot); documented that on Team/Enterprise plans only org Owners can add custom connectors, with the mcp-remote stdio bridge as the fallback.
  • Codex: added the required codex mcp login appwrite step, plus the GUI alternative (with screenshot).
  • Cursor: added post-setup auth note and screenshot of the connected server.
  • New clients: Gemini CLI, GitHub Copilot CLI, Zed, Warp, JetBrains AI Assistant/Junie, and Cline. Config formats verified against each client's official docs. JetBrains and Cline don't support OAuth for remote MCP servers yet, so those use the npx mcp-remote stdio bridge.

ChatGPT was intentionally left out for now — we'll pursue an official ChatGPT app directory listing instead of documenting the developer-mode flow.

Notes

Docs-only change (README + docs/images/).

- Add /mcp auth step for Claude Code
- Update Claude Desktop path to Settings -> Developer -> Local MCP servers,
  note Team/Enterprise custom-connector restriction (Owners only)
- Add codex mcp login step and GUI screenshot for Codex
- Add sections for Gemini CLI, GitHub Copilot CLI, Zed, Warp,
  JetBrains AI Assistant/Junie, and Cline (mcp-remote bridge where
  the client lacks remote OAuth support)
- Add setup screenshots for Claude Desktop, Cursor, and Codex
@greptile-apps

greptile-apps Bot commented Jul 9, 2026

Copy link
Copy Markdown

Greptile Summary

This PR expands the "Connect your client" section of the README with more complete setup instructions for existing clients (Claude Code, Claude Desktop, Cursor, Codex) and adds seven new client sections (Gemini CLI, GitHub Copilot CLI, Zed, Warp, JetBrains AI Assistant/Junie, Cline). Configuration formats and command syntax were cross-checked against official docs and appear accurate.

  • Existing clients updated: Added missing post-add auth steps (/mcp for Claude Code, codex mcp login for Codex, browser-login note for Cursor), corrected the Claude Desktop navigation path, and added -y to the npx mcp-remote invocation to avoid interactive prompts.
  • New clients added: Gemini CLI (httpUrl key confirmed), GitHub Copilot CLI (~/.copilot/mcp-config.json path confirmed), Zed (context_servers + url format confirmed), Warp (URL-based entry), and npx mcp-remote stdio bridges for JetBrains and Cline, which don't yet support OAuth for remote MCP servers.
  • Screenshots: Three new screenshots added for Claude Desktop, Codex GUI, and Cursor to accompany the written steps.

Confidence Score: 5/5

Docs-only change — no source code is modified, so no runtime regressions are possible.

The configuration formats and CLI commands across all seven new client sections were verified against official documentation (Gemini CLI, GitHub Copilot CLI, Zed, Warp, JetBrains, Cline). No incorrect instructions or broken paths were found. The only pre-existing concern (Warp navigation wording) was already flagged in a prior review thread.

No files require special attention.

Important Files Changed

Filename Overview
README.md Expanded "Connect your client" section with 7 new clients and more detailed auth steps for existing clients; configuration formats verified against official docs and look accurate.
docs/appwrite-mcp-flow.png New PNG version of the MCP flow diagram; README reference updated from .svg to .png.
docs/images/claude-desktop-local-mcp-servers.png New screenshot showing Appwrite server listed under Local MCP servers in Claude Desktop.
docs/images/codex-mcp.png New screenshot showing Appwrite MCP server settings in the Codex GUI.
docs/images/cursor-mcp.png New screenshot showing Appwrite server connected in Cursor's MCP settings panel.

Reviews (2): Last reviewed commit: "(docs): render OAuth flow diagram as PNG..." | Re-trigger Greptile

Comment thread README.md
SVG rendering on GitHub was poor; the SVG stays in docs/ as the
editable source, rendered at 2x via rsvg-convert.
@ChiragAgg5k ChiragAgg5k merged commit 03502a2 into main Jul 9, 2026
5 checks passed
@ChiragAgg5k ChiragAgg5k deleted the docs/mcp-client-setup branch July 9, 2026 06:09
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