Skip to main content

MCP server providing structured access to Reflex documentation

Project description

Reflex Docs MCP Server

Ground AI agents in real, up-to-date Reflex docs via a fast, local MCP server.

Python: 3.14 recommended. Compatible with 3.13+.

What It Does

  • Full‑text search over Reflex docs (SQLite FTS5)
  • Section‑level retrieval for precise context
  • Component index for rx.* lookups
  • FastMCP server with stdio and SSE transports

Quickstart

# Create venv
python3.14 -m venv .venv
. .venv/bin/activate

# Install (local checkout)
pip install -e .

# Index docs (clones Reflex docs and builds search index)
python -m reflex_docs_mcp.indexer

# Run MCP server (stdio)
python -m reflex_docs_mcp.server

# Run MCP server over SSE
python -m reflex_docs_mcp.server --transport sse --host 127.0.0.1 --port 8000

Install From PyPI

pip install reflex-docs-mcp

MCP Tools

  • search_docs(query)
  • get_doc(slug)
  • list_pages(prefix?, limit?)
  • list_components(category?)
  • search_components(query, limit?)
  • get_component(name)
  • get_stats()

Local MCP Config (VS Code)

The repository includes a ready-to-use config at .vscode/mcp.json that runs the server with the local venv.

Global Install MCP Config (VS Code)

If you install the package globally with pip, use one of these in .vscode/mcp.json:

Using module invocation:

{
  "servers": {
    "reflex-docs": {
      "type": "stdio",
      "command": "python3",
      "args": ["-m", "reflex_docs_mcp.server"],
      "env": {
        "REFLEX_DOCS_AUTO_INDEX": "true"
      }
    }
  },
  "inputs": []
}

Using the CLI entry point:

{
  "servers": {
    "reflex-docs": {
      "type": "stdio",
      "command": "reflex-docs-mcp",
      "args": [],
      "env": {
        "REFLEX_DOCS_AUTO_INDEX": "true"
      }
    }
  },
  "inputs": []
}

Project Layout

├── main.py                 # MCP stdio entry point
├── src/reflex_docs_mcp/
│   ├── models.py           # Pydantic data models
│   ├── database.py         # SQLite + FTS5 operations
│   ├── parser.py           # Markdown parser
│   ├── indexer.py          # Docs cloning & indexing
│   └── server.py           # MCP server (stdio + SSE)
├── render.yaml             # Render deployment config
├── Procfile                # Process definition
└── test.py                 # Groq + MCP demo client

Demo (Optional)

The demo client uses Groq (OpenAI-compatible API) and the MCP Python client.

pip install reflex-docs-mcp[demo]
cp env.example .env
# Add GROQ_API_KEY to .env
python test.py

Notes

  • env.example contains Groq settings.
  • The indexer writes to data/reflex_docs.db by default.
  • On startup, the server auto-builds the index if missing. Controls:
  • REFLEX_DOCS_AUTO_INDEX (default: true)
  • REFLEX_DOCS_DOCS_SRC (path to clone docs into, default: docs_src)
  • REFLEX_DOCS_SKIP_CLONE / REFLEX_DOCS_FORCE_CLONE
  • REFLEX_DOCS_KEEP_EXISTING

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

reflex_docs_mcp-0.1.1.tar.gz (13.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

reflex_docs_mcp-0.1.1-py3-none-any.whl (17.1 kB view details)

Uploaded Python 3

File details

Details for the file reflex_docs_mcp-0.1.1.tar.gz.

File metadata

  • Download URL: reflex_docs_mcp-0.1.1.tar.gz
  • Upload date:
  • Size: 13.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for reflex_docs_mcp-0.1.1.tar.gz
Algorithm Hash digest
SHA256 edbf023ef2a3b52be51b221041803e8f6673f70da12d2bd6d526ad76e9bf9acb
MD5 b5cbc71f20779fae2a3dbb432bee76fa
BLAKE2b-256 ecca46852c8e5c6eb976de9472a328567b6611a741ca8daf8f7bcd6af2a11e95

See more details on using hashes here.

Provenance

The following attestation bundles were made for reflex_docs_mcp-0.1.1.tar.gz:

Publisher: publish.yml on itsmeadarsh2008/reflex-docs-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file reflex_docs_mcp-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for reflex_docs_mcp-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ae8737e3e3f41a9cd11a964f1de8f9d4aeb47b178ad08e77ab71cd396dd178f8
MD5 46a21cb690468ddded160942b952f009
BLAKE2b-256 d144ea765f0b109cd51614319a4061c98ea2edb24c19d8ae28b3492a7f72467d

See more details on using hashes here.

Provenance

The following attestation bundles were made for reflex_docs_mcp-0.1.1-py3-none-any.whl:

Publisher: publish.yml on itsmeadarsh2008/reflex-docs-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page