cryosparc-docs-mcp
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@cryosparc-docs-mcp search for ab initio reconstruction parameters"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
cryosparc-docs-mcp
A small, read-only local MCP server that lets Codex / Claude Code search the
official CryoSPARC documentation (guide.cryosparc.com and
tools.cryosparc.com) with version awareness.
It never connects to a CryoSPARC instance, database, CLI, or job — it only serves text from a locally-built search index, so it is safe and fast.
How it works
Codex / Claude Code
└── cryosparc-docs MCP (local stdio, Python + uv)
└── local index: data/docs.sqlite (SQLite FTS5 / BM25)
↑ scripts/sync_docs.py fetches via sitemap (run weekly)
├── guide.cryosparc.com
└── tools.cryosparc.comThe server does no network I/O at runtime; it reads the prebuilt index only.
Related MCP server: context
Tools
tool | purpose |
| BM25 search; version-incompatible pages are ranked lower |
| bounded slice of one indexed page (allowlisted domains only) |
| document count + last sync time |
Every search result carries: title, source_url, official_source=true,
version_scope (v5.0+ / ≤v4.7 / v4.1+ / general), retrieved_at,
matched_excerpt.
Setup
cd /path/to/cryosparc-docs-mcp
uv sync # install deps
uv run python scripts/sync_docs.py # build the index (network; run weekly)
uv run python scripts/sync_docs.py --limit 20 # quick smoke testConfiguration lives in config.toml — notably default_version_scope
(general by default; set to v5.0+ or v4.7 to match your instance, since
cryosparcm version auto-detection is not available on this box).
Register the server
Codex — ~/.codex/config.toml:
[mcp_servers.cryosparc_docs]
command = "uv"
args = ["run", "python", "-m", "cryosparc_docs_mcp"]
cwd = "/path/to/cryosparc-docs-mcp"
enabled_tools = ["search_official_docs", "read_official_doc", "docs_status"]
default_tools_approval_mode = "auto"
startup_timeout_sec = 20
tool_timeout_sec = 30Verify: codex mcp list
Claude Code (user scope):
claude mcp add --transport stdio --scope user cryosparc-docs \
-- uv run --directory /path/to/cryosparc-docs-mcp \
python -m cryosparc_docs_mcpVerify: claude mcp list, then /mcp inside a session.
Agent usage policy
Add this to your AGENTS.md (Codex) and CLAUDE.md (Claude Code):
## CryoSPARC documentation policy
1. For any CryoSPARC CLI / cryosparc-tools API / job parameter / workflow /
version-specific question, call the cryosparc-docs MCP before answering or
editing code.
2. Prefer documentation matching the installed CryoSPARC version.
3. Include the source URL and version scope in the answer.
4. Do not infer undocumented API arguments.
5. Do not use CryoSPARC Forum posts unless explicitly requested.
6. Do not execute CryoSPARC commands solely based on retrieved docs.Development
uv run pytest # tests (no network)
uv run ruff check # lintAvailable Tools
3 toolsdocs_statusA
Report index health: document count and last sync timestamp.
Inputs: no named parameters.
read_official_docA
Return a bounded slice of one indexed official documentation page.
Only allowlisted official domains are accepted. Provide a heading to return
just that section. max_chars is capped at 20000 to protect context budget.
Inputs: url (required), heading, max_chars.
search_official_docsA
Search the official CryoSPARC docs index.
Args: query: Free-text query (CLI command, API name, parameter, workflow…). cryosparc_version: Target version such as "v5.0+" or "v4.7"; "auto" uses the server's configured default_version_scope. Version-incompatible pages are ranked below compatible ones. section: Restrict to "guide" or "tools"; omit for both. max_results: Number of hits to return (capped at 20).
Returns a dict with a "results" list; each result includes title, source_url, official_source, version_scope, retrieved_at, and matched_excerpt.
Inputs: query (required), section, max_results, cryosparc_version.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 3 tools
Each tool has a distinct purpose: docs_status reports index health, read_official_doc retrieves a page or section, and search_official_docs performs free-text search. There is no ambiguity or overlap.
All tool names follow a consistent verb_noun pattern using snake_case: docs_status, read_official_doc, search_official_docs. The naming is predictable and clear.
With only 3 tools, the set is minimal but covers the essential documentation operations: checking health, reading a specific doc, and searching. It is well-scoped for its purpose, though a few additional tools (e.g., listing available pages) might enhance completeness.
The tool set covers the core workflows of browsing documentation: searching, reading, and checking index status. Missing is the ability to list or navigate documentation structure, but the search+read combination likely suffices for most agent tasks.
Maintenance
Related MCP Connectors
Versioned documentation registry and semantic search for AI tools and coding assistants.
Search @imqueue docs and scaffold typed services & clients from your AI coding agent.
Search NVIDIA CUDA documentation and code samples from AI coding agents.
Search the official docs of Claude Code, Cursor, OpenAI Codex and MCP, refreshed daily.
Related MCP Servers
- MIT
- AlicenseNot gradedqualityCmaintenanceProvides up-to-date documentation for AI agents by locally querying a community-driven registry of pre-built docs packages.Apache 2.0
- AlicenseNot gradedqualityDmaintenanceProvides local technical documentation with hybrid search (semantic + BM25) for AI agents, ensuring access to up-to-date framework docs.MIT
- AlicenseAqualityBmaintenanceEnables agents like Codex to search and read MetaX official documentation, MetaX-MACA GitHub content, and Docker image catalog entries from a local offline index, with source citations returned for each result.4Apache 2.0