Skip to content

docs: add transport type and client setup guides#97

Open
gfsaaser24 wants to merge 1 commit intocloudflare:mainfrom
gfsaaser24:docs/add-client-specific-setup-instructions
Open

docs: add transport type and client setup guides#97
gfsaaser24 wants to merge 1 commit intocloudflare:mainfrom
gfsaaser24:docs/add-client-specific-setup-instructions

Conversation

@gfsaaser24
Copy link
Copy Markdown

Summary

  • Adds explicit "type": "http" to all JSON configuration examples
  • Adds a transport type callout noting this is an HTTP (Streamable HTTP) server, not SSE or stdio
  • Adds a Client Setup Guides section with step-by-step instructions for Claude Code (CLI), Claude Desktop, and Cursor/Windsurf
  • Adds a Transport row to the "Add to Agent" settings table
  • Includes a note about restarting after first OAuth connection

Context

When setting up the MCP server with Claude Code, the connection fails when using the default sse transport type. The server requires http (Streamable HTTP) transport. This PR documents the correct transport type across all config examples and adds client-specific setup commands to reduce friction for new users.

Test plan

  • Verified Claude Code connects successfully with --transport http
  • Verified sse transport fails, http transport works
  • Confirmed OAuth flow completes and search/execute tools are available after connection
  • All existing README content preserved — 51 lines added, 0 lines removed

🤖 Generated with Claude Code

…/Cursor

- Add explicit `"type": "http"` to all JSON config examples
- Add transport type callout (HTTP, not SSE or stdio)
- Add Client Setup Guides section with Claude Code CLI, Claude Desktop, and Cursor/Windsurf instructions
- Add Transport row to the Add to Agent settings table
- Note about restarting after OAuth on first connection

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
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