Skip to content

Commit 29d9e63

Browse files
authored
Create Beta MCP_README (#5395)
1 parent a0d508c commit 29d9e63

1 file changed

Lines changed: 97 additions & 0 deletions

File tree

MCP_README

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
# Reflex MCP Server - User Guide
2+
3+
> **⚠️ ALPHA VERSION**: This MCP server is currently in alpha and under active development. Features may change, and you might encounter occasional issues. We appreciate your feedback and patience as we continue to improve the service.
4+
5+
The Reflex MCP Server provides comprehensive access to Reflex framework documentation and component information through the Model Context Protocol (MCP). This server is deployed and ready to use with your MCP-compatible AI tools.
6+
7+
## 🚀 Quick Start
8+
9+
The server is live at: **https://reflex-mcp-server.fly.dev**
10+
11+
> **Note**: As this is an alpha service, there may be occasional downtime for updates and improvements.
12+
13+
### Available Endpoints
14+
- **SSE (Server-Sent Events)**: `https://reflex-mcp-server.fly.dev/sse`
15+
- **HTTP API**: `https://reflex-mcp-server.fly.dev/mcp`
16+
17+
## 🛠️ Available Tools
18+
19+
### Component Documentation
20+
21+
#### `get_component_doc`
22+
Get complete documentation and source code for any Reflex component.
23+
24+
**Example**: Ask "Show me the Button component" → Returns docs, code, and examples.
25+
26+
#### `list_components`
27+
Browse all available Reflex components by category.
28+
29+
**Example**: Ask "What form components are available?" → Shows all form-related components.
30+
31+
### Documentation Access
32+
33+
#### `list_doc_sections`
34+
Explore the complete Reflex documentation structure.
35+
36+
**Example**: Ask "What documentation is available?" → Shows all doc sections and topics.
37+
38+
#### `get_doc`
39+
Read any specific documentation file.
40+
41+
**Example**: Ask "Show me the getting started guide" → Returns the full documentation content.
42+
43+
## 🔧 MCP Client Configuration
44+
45+
### Claude Desktop
46+
Add this to your Claude Desktop configuration file:
47+
48+
```bash
49+
claude mcp add --transport sse reflex https://reflex-mcp-server.fly.dev/sse
50+
```
51+
52+
### Cursor/Windsurf
53+
Create `.vscode/mcp.json` in your project:
54+
55+
```json
56+
{
57+
"mcpServers": {
58+
"reflex": {
59+
"serverType": "sse",
60+
"url": "https://reflex-mcp-server.fly.dev/sse"
61+
}
62+
}
63+
}
64+
```
65+
66+
### Codex
67+
Add this to your `~/.codex/config.toml` file:
68+
69+
```toml
70+
[mcp_servers.reflex]
71+
command = "npx"
72+
args = ["-y", "@modelcontextprotocol/server-proxy"]
73+
env = { "MCP_PROXY_URL" = "https://reflex-mcp-server.fly.dev/sse" }
74+
```
75+
76+
> **Note**: Codex currently requires MCP servers to communicate over stdio. Since our server uses SSE, you'll need the `@modelcontextprotocol/server-proxy` adapter to bridge the connection.
77+
78+
### Other MCP Clients
79+
For other MCP-compatible tools, use:
80+
- **SSE URL**: `https://reflex-mcp-server.fly.dev/sse`
81+
- **HTTP URL**: `https://reflex-mcp-server.fly.dev/mcp`
82+
83+
84+
## 🔍 Server Status
85+
86+
Check if the server is running:
87+
- Visit: https://reflex-mcp-server.fly.dev
88+
- Should return server information and available tool count
89+
## 💰 Pricing & Future Plans
90+
91+
**Current Alpha**: This MCP server is **completely free** to use during the alpha period. No registration, API keys, or payment required.
92+
93+
**Future Pricing**: Once out of alpha, this service will be integrated into Reflex Pro+ subscription plans. However, we're committed to keeping Reflex accessible:
94+
95+
- **Free Tier**: Will continue to be available with reasonable usage limits
96+
- **Pro+ Plans**: Will offer enhanced features, higher rate limits, and priority support
97+
- **Enterprise**: Custom solutions for organizations with specific needs

0 commit comments

Comments
 (0)