Skip to content

Conversation

avvijeet
Copy link

Add IDE-specific MCP configuration examples with documentation links

Describe your changes

Enhanced the quickstart documentation to provide clear, IDE-specific MCP configuration instructions for all three major MCP clients:

  1. Claude Desktop:

    • Added CLI-based configuration example using claude mcp add command
    • Included command to list configured servers
    • Highlighted that Claude Desktop uses the url parameter
    • Added link to Anthropic's official documentation
  2. Cursor:

    • Maintained the JSON configuration example with the url parameter
    • Added clear section header for better organization
    • Added link to Cursor's official documentation
  3. Windsurf:

    • Created a dedicated section for Windsurf configuration
    • Explicitly noted that Windsurf uses serverUrl instead of url
    • Added link to Windsurf's official documentation

These changes ensure that developers can correctly configure their MCP clients on the first attempt, regardless of which IDE they're using. The documentation now provides proper references to official documentation for each platform, allowing users to find more detailed information if needed.

Issue ticket number and link (if applicable)

N/A - Documentation enhancement

Screenshots of the feature / bugfix

Before:

All the most popular MCP clients (Claude Desktop, Cursor & Windsurf) use the following config format:

{
  "mcpServers": {
    "fastapi-mcp": {
      "url": "http://localhost:8000/mcp"
    }
  }
}

After:

{
  "mcpServers": {
    "fastapi-mcp": {
      "serverUrl": "http://localhost:8000/mcp"
    }
  }
}

Checklist before requesting a review

  • Added relevant tests - N/A (Documentation only)
  • Run ruff & mypy - N/A (Documentation only)
  • All tests pass - N/A (Documentation only)

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