risc0-mcp-server
v1.0.1
Published
Model Context Protocol (MCP) server for RISC Zero documentation - enables AI assistants to access zkVM docs programmatically
Maintainers
Readme
RISC Zero MCP Documentation Server
Model Context Protocol (MCP) server that provides programmatic access to RISC Zero documentation, enabling AI assistants like Claude to help developers build zkVM applications.
Features
- 🔍 Full-text search across all RISC Zero documentation
- 📚 Documentation retrieval for specific topics and tutorials
- 💡 Example browser with 25+ zkVM example applications
- 🔧 API reference access to Rust crate documentation
- ❓ FAQ lookup for common questions
- 📖 Terminology definitions for zkVM concepts
- ⚡ Fast caching for improved performance
- 🔒 No API keys required for basic usage
Available Tools
search_docs- Search documentation by keywordget_documentation- Get specific doc pageslist_examples- Browse all examplesget_example- Get detailed example infoget_api_reference- Access API docsget_faq- Query FAQsget_terminology- Look up terms
Installation
Using npm:
npm install -g risc0-mcp-server
# or run directly
npx risc0-mcp-serverUsing Bun (faster):
bun install -g risc0-mcp-server
# or run directly
bunx risc0-mcp-serverUsage
Claude Desktop
Add to your Claude Desktop configuration file:
macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Windows: %APPDATA%\Claude\claude_desktop_config.json
{
"mcpServers": {
"risc0-docs": {
"command": "npx",
"args": ["-y", "risc0-mcp-server"]
}
}
}Then restart Claude Desktop.
Claude Code
claude mcp add risc0-docs -- npx -y risc0-mcp-serverOpenCode
Add to your opencode.json configuration:
{
"mcp": {
"risc0-docs": {
"type": "local",
"command": ["npx", "-y", "risc0-mcp-server"]
}
}
}Cursor
Open Cursor Settings > MCP and add a new server:
{
"mcpServers": {
"risc0-docs": {
"command": "npx",
"args": ["-y", "risc0-mcp-server"]
}
}
}Windsurf
Open Windsurf Settings > MCP and add:
{
"mcpServers": {
"risc0-docs": {
"command": "npx",
"args": ["-y", "risc0-mcp-server"]
}
}
}Any MCP-compatible client
This server uses stdio transport. Run it with any MCP client by executing:
npx -y risc0-mcp-serverExample Queries
Once connected, ask your AI assistant:
- "Search RISC Zero docs for zkVM quickstart guide"
- "Show me the password checker example"
- "What is a receipt in RISC Zero?"
- "List all available zkVM examples"
- "Get API reference for risc0-zkvm crate"
Development
Using Bun (recommended - faster):
# Clone repository
git clone https://github.com/ELDEVODE/risc0-mcp-server.git
cd risc0-mcp-server
# Install dependencies
bun install
# Build
bun run build
# Run in development mode (with hot reload)
bun run dev
# Lint and format
bun run lint
bun run formatUsing npm:
# Clone repository
git clone https://github.com/ELDEVODE/risc0-mcp-server.git
cd risc0-mcp-server
# Install dependencies
npm install
# Build
npm run build
# Run in development mode
npm run dev:npm
# Lint and format
npm run lint
npm run formatArchitecture
- Runtime: Compatible with both Bun and Node.js 18+
- Package Manager: Works with both bun and npm
- Server: MCP protocol implementation with stdio transport
- Tools: 7 specialized documentation tools
- Fetcher: GitHub API integration for fetching docs
- Indexer: In-memory search index
- Parser: Markdown and frontmatter parsing
- Cache: TTL-based caching layer
Environment Variables
GITHUB_TOKEN(optional): GitHub personal access token for higher API rate limits (60/hour unauthenticated, 5000/hour authenticated)
Contributing
Contributions welcome! Please:
- Fork the repository
- Create a feature branch
- Make your changes
- Add tests if applicable
- Submit a pull request
License
MIT License - see LICENSE file
Links
Built with ❤️ by the RISC Zero Community
