Skip to content

docs: Add comprehensive MCP documentation section #19255

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

matifali
Copy link
Member

@matifali matifali commented Aug 8, 2025

Summary

Adds a new dedicated Model Context Protocol (MCP) section to the Coder documentation, providing comprehensive setup guides for various AI tools and IDEs.

Changes

New MCP Documentation Section

  • Landing page (docs/mcp/index.md) - Explains what Coder MCP is, its benefits, and how it works
  • IDE-specific setup guides:
    • VSCode (docs/mcp/vscode.md)
    • Cursor (docs/mcp/cursor.md)
    • Zed (docs/mcp/zed.md)
    • WindSurf (docs/mcp/windsurf.md)
    • Claude Desktop (docs/mcp/claude-desktop.md)
    • Web-based agents (docs/mcp/web-agents.md)

Documentation Structure Updates

  • Updated docs/manifest.json to organize MCP as a dedicated section with proper navigation
  • Enhanced docs/ai-coder/mcp-server.md as a technical reference with better organization and comprehensive troubleshooting

Benefits

  • Clear user guidance: Each guide provides step-by-step setup instructions for specific AI tools
  • Better organization: MCP content is now properly structured as a dedicated section
  • Comprehensive coverage: Covers both local (stdio) and remote (HTTP) MCP server modes
  • Practical examples: Includes real-world usage examples and troubleshooting tips

Testing

  • Verified JSON syntax in manifest.json
  • Confirmed all internal links are correct
  • Reviewed content for accuracy and completeness

This addresses the need for dedicated MCP documentation that was discussed in the team channel, providing users with clear, IDE-specific guidance for setting up Model Context Protocol integration with their AI assistants.

Adds a new dedicated MCP section to the documentation with:
- Landing page explaining Coder MCP and its benefits
- Setup guides for VSCode, Cursor, Zed, WindSurf, Claude Desktop, and web agents
- Updated manifest.json to organize MCP docs as a dedicated section
- Enhanced mcp-server.md as technical reference with better organization

This provides users with clear, IDE-specific guidance for setting up
Model Context Protocol integration with their AI assistants.

Co-authored-by: matifali <10648092+matifali@users.noreply.github.com>
@matifali matifali marked this pull request as draft August 8, 2025 13:26
**Enable HTTP MCP Server**:
```sh
# Enable experimental features
CODER_EXPERIMENTS="oauth2,mcp-server-http" coder server
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

double check if mcp-server-http is a valid experiment.

blink-so bot and others added 2 commits August 8, 2025 13:31
- Add language specifications to code blocks
- Fix ordered list numbering issues
- Ensure all markdown follows project style guidelines

Co-authored-by: matifali <10648092+matifali@users.noreply.github.com>
- Fix relative paths to reference correct documentation files
- Update pkg.go.dev links to use valid version format
- Ensure all internal links point to existing files

Resolves linkspector issues identified in CI.

Co-authored-by: matifali <10648092+matifali@users.noreply.github.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