Docs.rs

Streamlines Rust documentation workflows by providing tools for building, managing, and searching crate documentation through cargo doc commands with caching and error handling.

Installation Instructions

README: https://github.com/spacemeowx2/cargo-doc-mcp

cargo doc MCP Server

A MCP server for managing Rust documentation through cargo doc commands. This server provides tools to check, build, and search Rust documentation locally.

Features

Tools

• get_crate_doc - Get crate's main documentation page for understanding overall concepts and usage

  • Parameters:
    • project_path: Path to the Rust project (must be absolute path)
    • crate_name: Name of the crate to get documentation for

• list_symbols - List all symbols (structs, enums, traits, etc.) in a crate's documentation

  • Parameters:
    • project_path: Path to the Rust project (must be absolute path)
    • crate_name: Name of the crate to list symbols for

• search_doc - Search within a crate's documentation

  • Parameters:
    • project_path: Path to the Rust project (must be absolute path)
    • crate_name: Name of the crate to search in
    • query: Search query (keyword or symbol)
    • limit (optional): Maximum number of results to return (default: 10)

Requirements

• Node.js 16 or later
• Rust and Cargo installed

Installation

Install dependencies:

pnpm install

Build the server:

pnpm run build

For development with auto-rebuild:

pnpm run watch

Usage

Add the following configuration:

{
  "mcpServers": {
    "docs-rs-mcp": {
      "command": "/absolute/path/to/docs-rs-mcp/build/index.js"
    }
  }
}

Debugging

Since MCP servers communicate over stdio, debugging can be challenging. We recommend using the MCP Inspector:

pnpm run inspector

The Inspector will provide a URL to access debugging tools in your browser.

Cache System

The server maintains a cache of built documentation paths to improve performance. Cache entries expire after 24 hours to ensure documentation stays up-to-date.

License

MIT