Skip to content

Commit 85c1160

Browse files
Simplify MCP documentation per GitHub feedback
- 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>
1 parent bc63630 commit 85c1160

File tree

1 file changed

+4
-168
lines changed
  • docs/ai_builder/integrations

1 file changed

+4
-168
lines changed

docs/ai_builder/integrations/mcp.md

Lines changed: 4 additions & 168 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,9 @@
44
import reflex as rx
55
```
66

7-
The Reflex Model Context Protocol (MCP) integration provides AI assistants and coding tools with structured access to Reflex framework documentation and component information. This enables intelligent assistance while developing Reflex applications.
7+
The Reflex [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) integration provides AI assistants and coding tools with structured access to Reflex framework documentation and component information. This enables intelligent assistance while developing Reflex applications.
88

9-
## What is Model Context Protocol (MCP)?
10-
11-
Model Context Protocol (MCP) is a standardized way for AI tools to access external data sources and services. The Reflex MCP server provides real-time access to:
12-
13-
- **Component Documentation**: Complete documentation for all Reflex components with source code
14-
- **Documentation Sections**: Hierarchical access to all Reflex documentation
15-
- **Resource Discovery**: Browse available components and documentation as MCP resources
16-
- **Tool-based Access**: Retrieve specific documentation through standardized MCP tools
17-
18-
The Reflex MCP server is deployed at `https://mcp.reflex.dev/mcp` and uses streamable HTTP transport for maximum compatibility with different AI tools.
9+
The Reflex MCP server is deployed at `https://mcp.reflex.dev/mcp` and provides access to component documentation and Reflex documentation through standardized MCP tools.
1910

2011
## Installation
2112

@@ -29,31 +20,7 @@ To use the Reflex MCP integration, you'll need to configure your AI assistant or
2920

3021
## Authentication
3122

32-
```python eval
33-
rx.box(height="1rem")
34-
```
35-
36-
```python eval
37-
rx.accordion.root(
38-
rx.accordion.item(
39-
header="Authentication Details",
40-
content=rx.box(
41-
rx.text("The Reflex MCP server uses ", rx.el.span("OAuth 2.1 protocol", font_weight="bold"), " for secure authentication."),
42-
rx.box(height="0.5rem"),
43-
rx.text("", rx.el.span("Reflex account required", font_weight="bold")),
44-
rx.text("", rx.el.span("OAuth 2.1 authentication", font_weight="bold")),
45-
rx.text("", rx.el.span("Secure token-based access", font_weight="bold")),
46-
rx.box(height="0.5rem"),
47-
rx.text("Authentication is handled automatically through your MCP client configuration when you provide your Reflex credentials."),
48-
),
49-
),
50-
variant="surface",
51-
)
52-
```
53-
54-
```python eval
55-
rx.box(height="1rem")
56-
```
23+
The Reflex MCP server uses OAuth 2.1 protocol for secure authentication. You'll need a valid Reflex account, and authentication is handled automatically through your MCP client configuration when you provide your Reflex credentials.
5724

5825
## IDE and Coding Assistant Integration
5926

@@ -103,138 +70,7 @@ env = { "MCP_PROXY_URL" = "https://mcp.reflex.dev/mcp" }
10370

10471
Note: Codex requires MCP servers to communicate over stdio. The `@modelcontextprotocol/server-proxy` adapter bridges the connection to the HTTP-based Reflex MCP server.
10572

106-
### Other MCP Clients
107-
108-
For other MCP-compatible tools, use this endpoint:
109-
110-
```python eval
111-
rx.table.root(
112-
rx.table.header(
113-
rx.table.row(
114-
rx.table.column_header_cell("Transport"),
115-
rx.table.column_header_cell("URL"),
116-
rx.table.column_header_cell("Authentication"),
117-
),
118-
),
119-
rx.table.body(
120-
rx.table.row(
121-
rx.table.row_header_cell(rx.code("HTTP")),
122-
rx.table.cell(rx.code("https://mcp.reflex.dev/mcp")),
123-
rx.table.cell("OAuth 2.1 via MCP client"),
124-
),
125-
),
126-
width="100%",
127-
)
128-
```
12973

13074
## Available Tools
13175

132-
The Reflex MCP server provides several tools for accessing documentation and component information:
133-
134-
### Component Documentation
135-
136-
**`get_component_doc`** - Retrieve comprehensive documentation for any Reflex component, including markdown documentation, Python source code, and related component sources.
137-
138-
Example usage: "Show me the Button component documentation"
139-
140-
**`list_components`** - Browse all available Reflex components organized by category.
141-
142-
Example usage: "What form components are available in Reflex?"
143-
144-
### Documentation Access
145-
146-
**`list_doc_sections`** - Explore the complete Reflex documentation structure hierarchically.
147-
148-
Example usage: "What documentation sections are available?"
149-
150-
**`get_doc`** - Read any specific documentation file from the Reflex documentation.
151-
152-
Example usage: "Show me the getting started guide"
153-
154-
## Best Practices
155-
156-
### Effective Usage
157-
158-
1. **Be Specific**: When asking for component documentation, specify the exact component name for best results.
159-
160-
2. **Explore Categories**: Use `list_components` to discover components by category before diving into specific documentation.
161-
162-
3. **Leverage Context**: The MCP server provides rich context including source code, which helps AI assistants give more accurate advice.
163-
164-
4. **Documentation Structure**: Use `list_doc_sections` to understand the full scope of available documentation before asking specific questions.
165-
166-
### Optimization Tips
167-
168-
- **Component Discovery**: Start with category-based searches to find the right components for your use case
169-
- **Source Code Access**: The server provides both documentation and source code, enabling deeper understanding of component behavior
170-
- **Related Components**: Component documentation includes information about related components through YAML frontmatter parsing
171-
172-
## Troubleshooting
173-
174-
### Connection Issues
175-
176-
**Problem**: AI assistant cannot connect to the MCP server
177-
178-
**Solutions**:
179-
- Verify your internet connection
180-
- Check that the server is running by visiting `https://mcp.reflex.dev/mcp`
181-
- Ensure your MCP client configuration uses the correct URL format
182-
- Verify your OAuth 2.1 authentication credentials are valid
183-
184-
### Configuration Problems
185-
186-
**Problem**: MCP server not appearing in your AI tool
187-
188-
**Solutions**:
189-
- Double-check the configuration file syntax (JSON/TOML formatting)
190-
- Restart your AI assistant after adding the configuration
191-
- Verify the configuration file is in the correct location for your tool
192-
- Check your AI tool's documentation for MCP setup requirements
193-
194-
### Limited Functionality
195-
196-
**Problem**: Some tools or documentation not accessible
197-
198-
**Solutions**:
199-
- Some features may be temporarily unavailable during updates
200-
- Check the server status at `https://mcp.reflex.dev/mcp`
201-
- Verify your authentication credentials are properly configured
202-
- Report issues to the Reflex team for investigation
203-
204-
### Performance Issues
205-
206-
**Problem**: Slow responses from the MCP server
207-
208-
**Solutions**:
209-
- The server is hosted and may experience occasional latency
210-
- Large documentation requests may take longer to process
211-
- Consider breaking complex queries into smaller, specific requests
212-
- Check your network connection stability
213-
214-
## Server Status
215-
216-
You can check if the Reflex MCP server is running by visiting: `https://mcp.reflex.dev/mcp`
217-
218-
The endpoint will show server information and available MCP capabilities.
219-
220-
```python eval
221-
rx.box(height="1rem")
222-
```
223-
224-
```python eval
225-
rx.accordion.root(
226-
rx.accordion.item(
227-
header="Alpha Service Notice",
228-
content=rx.box(
229-
rx.text("⚠️ ", rx.el.span("ALPHA VERSION", font_weight="bold"), ": This MCP server is currently in alpha and under active development."),
230-
rx.box(height="0.5rem"),
231-
rx.text("• Features may change without notice"),
232-
rx.text("• Occasional downtime for updates and improvements"),
233-
rx.text("• Your feedback helps improve the service"),
234-
rx.box(height="0.5rem"),
235-
rx.text("We appreciate your patience as we continue to enhance the Reflex MCP integration."),
236-
),
237-
),
238-
variant="surface",
239-
)
240-
```
76+
The Reflex MCP server provides tools for accessing component documentation and Reflex documentation through standardized MCP capabilities.

0 commit comments

Comments
 (0)