Docs.rs

🚀 Freight Documentation MCP Server

This is an MCP server for managing Rust documentation via the cargo doc command. It provides tools for checking, building, and searching local Rust documentation.

✨ Features

Tools

• get_crate_doc - Retrieve the main documentation page of a crate to understand the overall concepts and usage.

  • Parameters:
    • project_path: The project path (must be an absolute path).
    • crate_name: The name of the crate for which to retrieve the documentation.

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

  • Parameters:
    • project_path: The project path (must be an absolute path).
    • crate_name: The name of the crate for which to list the symbols.

• search_doc - Search for content in the crate's documentation.

  • Parameters:
    • project_path: The project path (must be an absolute path).
    • crate_name: The name of the crate in which to search.
    • query: The search query (keyword or symbol).
    • limit (optional): The maximum number of results to return (default: 10).

📦 Installation

Requirements

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

Steps

Install dependencies:

pnpm install

Build the server:

pnpm run build

Development mode (auto-rebuild):

pnpm run watch

💻 Usage Examples

Basic Usage

Add the following configuration:

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

📚 Documentation

Debugging

Since the MCP server communicates via standard input and output, debugging can be challenging. We recommend using the MCP Inspector:

pnpm run inspector

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

Cache System

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

📄 License

MIT