Add comprehensive MCP integration documentation#1549
Conversation
- Create docs/ai_builder/integrations/mcp.md with complete MCP integration guide - Include sections: introduction, installation, authentication, IDE integrations, best practices, troubleshooting - Add support for Claude Desktop, Windsurf/Cascade, Codex, and other MCP clients - Update sidebar navigation to include MCP alongside GitHub and database integrations - Document Reflex MCP server endpoints and configuration examples Fixes ENG-6748 Co-Authored-By: khaleel@reflex.dev <khaleel.aladhami@gmail.com>
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
There was a problem hiding this comment.
Greptile Summary
This PR adds comprehensive documentation for the Reflex Model Context Protocol (MCP) integration to the website. The change introduces a new documentation page at docs/ai_builder/integrations/mcp.md that provides complete guidance for users to install, configure, and use the Reflex MCP server with various AI assistants and coding tools.
The documentation covers installation instructions, authentication (noting the alpha service requires no auth currently), and detailed configuration examples for multiple IDEs including Claude Desktop, Windsurf/Cascade, and Codex. It documents the MCP server endpoints at https://reflex-mcp-server.fly.dev with both SSE and HTTP transport options, and includes troubleshooting sections and best practices.
To integrate this new documentation into the site, the PR makes a minimal change to pcweb/components/docpage/sidebar/sidebar_items/ai.py, adding a single line (ai_builder.integrations.mcp) to the AI Builder integrations section. This leverages Reflex's existing namespace-based documentation system where markdown files in the docs/ directory are automatically converted to routes and made available through the sidebar navigation.
The documentation follows established patterns in the AI Builder section and uses appropriate Reflex components like accordions and tables for interactive content, maintaining consistency with the rest of the documentation site.
Confidence score: 4/5
- This PR appears safe to merge with well-structured documentation following established patterns and minimal navigation changes
- Score reflects the alpha status of the documented service and inability to verify external endpoints, but the implementation itself follows proper conventions
- The new documentation file needs attention to verify technical accuracy of server endpoints and IDE configuration examples
2 files reviewed, 1 comment
|
the docs for this are mostly wrong, the only supported domain is |
- Update server URL to https://mcp.reflex.dev/mcp - Correct authentication to OAuth 2.1 protocol - Remove references to SSE endpoints and local repos - Update all IDE configuration examples with correct endpoint - Fix spacing issue in MCP protocol description Addresses feedback from @adhami3310 on PR #1549 Co-Authored-By: khaleel@reflex.dev <khaleel.aladhami@gmail.com>
- Update server status URLs to https://mcp.reflex.dev/mcp - Remove references to unsupported SSE connections - Update troubleshooting solutions to reflect OAuth 2.1 authentication Completes corrections from @adhami3310 feedback on PR #1549 Co-Authored-By: khaleel@reflex.dev <khaleel.aladhami@gmail.com>
- Remove all spacing elements (rx.box height elements) - Remove hardcoded examples and detailed explanations - Remove entire Best Practices and Troubleshooting sections - Remove Other MCP Clients table section - Simplify Available Tools section to just mention capabilities - Add link to official MCP documentation - Keep only essential installation and IDE configuration info Addresses all GitHub comments from @adhami3310 on PR #1549 Co-Authored-By: khaleel@reflex.dev <khaleel.aladhami@gmail.com>
- Add Enterprise Use section mentioning on-prem deployment availability - Include link to book demo at https://reflex.dev/pricing/ - Addresses GitHub comment from @adhami3310 on PR #1549 Co-Authored-By: khaleel@reflex.dev <khaleel.aladhami@gmail.com>
|
can you add this as a section next to "Learn" in the "AI Builder"? |
- Add MCP sidebar category alongside Learn in AI Builder - Update sidebar content handling to support multiple sections - Use 'plug' icon for MCP section - Addresses GitHub comment from @adhami3310 on PR #1549 The MCP section now appears at the same hierarchical level as Learn in the AI Builder navigation, making it easily discoverable. Co-Authored-By: khaleel@reflex.dev <khaleel.aladhami@gmail.com>
|
make it such that it only appears in its own section, not in the learn section, and divide it into overview and installation |
…allation subsections - Remove MCP from Learn section's Integrations to prevent duplication - Create dedicated get_sidebar_items_mcp() function with Overview and Installation subsections - Update sidebar.py to use mcp_items instead of ai_builder_overview_items[3] - Add clear Overview section header in MCP documentation - Addresses GitHub PR feedback to ensure MCP only appears in its own section Co-Authored-By: khaleel@reflex.dev <khaleel.aladhami@gmail.com>
|
divide the article to two, one for overview and one for installation, also those shouldn't be sections they should be articles under one section |
- Create mcp_overview.md with MCP introduction, available tools, and enterprise info - Create mcp_installation.md with prerequisites, authentication, and IDE integration guides - Update sidebar to show one 'MCP Integration' section containing both articles - Remove original mcp.md file to avoid duplication - Addresses GitHub comment requesting articles under one section instead of subsections Co-Authored-By: khaleel@reflex.dev <khaleel.aladhami@gmail.com>
- Update ai_builder_pages.integrations.mcp.path to mcp_overview.path - Update hardcoded path from /mcp to /mcp-overview - Resolves AttributeError preventing reflex export from completing Co-Authored-By: khaleel@reflex.dev <khaleel.aladhami@gmail.com>
|
you should make the page says Overview/Installation not MCP Overview/MCP Installation |
…allation' per GitHub feedback Co-Authored-By: khaleel@reflex.dev <khaleel.aladhami@gmail.com>
Restructure MCP sidebar: remove from Learn section, add Overview/Installation subsections
Summary
This PR addresses GitHub feedback to ensure MCP only appears in its own top-level section in the AI Builder sidebar, divided into "Overview" and "Installation" subsections. Previously, MCP was appearing in both the Learn section's Integrations and as its own top-level section.
Key changes:
get_sidebar_items_mcp()function with Overview and Installation subsectionsReview & Testing Checklist for Human
Note: Due to environment issues, I couldn't fully test the changes locally with
reflex run, so manual verification of the sidebar behavior is critical.Diagram
%%{ init : { "theme" : "default" }}%% graph TD ai_py["pcweb/components/docpage/<br/>sidebar/sidebar_items/ai.py"]:::major-edit sidebar_py["pcweb/components/docpage/<br/>sidebar/sidebar.py"]:::major-edit mcp_md["docs/ai_builder/<br/>integrations/mcp.md"]:::minor-edit ai_py -->|"imports mcp_items"| sidebar_py ai_py -->|"references"| mcp_md integrations["Learn Section<br/>Integrations"]:::context mcp_section["MCP Top-level<br/>Section"]:::context ai_py -->|"removed MCP from"| integrations ai_py -->|"created subsections for"| mcp_section subgraph Legend L1[Major Edit]:::major-edit L2[Minor Edit]:::minor-edit L3[Context/No Edit]:::context end classDef major-edit fill:#90EE90 classDef minor-edit fill:#87CEEB classDef context fill:#FFFFFFNotes
that was present before these changes
Session: https://app.devin.ai/sessions/9bcd2cfb49e44df0a684451b88c0b6a8
Requested by: @adhami3310
Ticket: ENG-6748