Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
97 changes: 97 additions & 0 deletions MCP_README
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
# Reflex MCP Server - User Guide

> **⚠️ 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.

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.

## 🚀 Quick Start

The server is live at: **https://reflex-mcp-server.fly.dev**

> **Note**: As this is an alpha service, there may be occasional downtime for updates and improvements.

### Available Endpoints
- **SSE (Server-Sent Events)**: `https://reflex-mcp-server.fly.dev/sse`
- **HTTP API**: `https://reflex-mcp-server.fly.dev/mcp`

## 🛠️ Available Tools

### Component Documentation

#### `get_component_doc`
Get complete documentation and source code for any Reflex component.

**Example**: Ask "Show me the Button component" → Returns docs, code, and examples.

#### `list_components`
Browse all available Reflex components by category.

**Example**: Ask "What form components are available?" → Shows all form-related components.

### Documentation Access

#### `list_doc_sections`
Explore the complete Reflex documentation structure.

**Example**: Ask "What documentation is available?" → Shows all doc sections and topics.

#### `get_doc`
Read any specific documentation file.

**Example**: Ask "Show me the getting started guide" → Returns the full documentation content.

## 🔧 MCP Client Configuration

### Claude Desktop
Add this to your Claude Desktop configuration file:

```bash
claude mcp add --transport sse reflex https://reflex-mcp-server.fly.dev/sse
```

### Cursor/Windsurf
Create `.vscode/mcp.json` in your project:

```json
{
"mcpServers": {
"reflex": {
"serverType": "sse",
"url": "https://reflex-mcp-server.fly.dev/sse"
}
}
}
```

### Codex
Add this to your `~/.codex/config.toml` file:

```toml
[mcp_servers.reflex]
command = "npx"
args = ["-y", "@modelcontextprotocol/server-proxy"]
env = { "MCP_PROXY_URL" = "https://reflex-mcp-server.fly.dev/sse" }
```

> **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.

### Other MCP Clients
For other MCP-compatible tools, use:
- **SSE URL**: `https://reflex-mcp-server.fly.dev/sse`
- **HTTP URL**: `https://reflex-mcp-server.fly.dev/mcp`


## 🔍 Server Status

Check if the server is running:
- Visit: https://reflex-mcp-server.fly.dev
- Should return server information and available tool count
## 💰 Pricing & Future Plans

**Current Alpha**: This MCP server is **completely free** to use during the alpha period. No registration, API keys, or payment required.

**Future Pricing**: Once out of alpha, this service will be integrated into Reflex Pro+ subscription plans. However, we're committed to keeping Reflex accessible:

- **Free Tier**: Will continue to be available with reasonable usage limits
- **Pro+ Plans**: Will offer enhanced features, higher rate limits, and priority support
- **Enterprise**: Custom solutions for organizations with specific needs