FAQ

What is the MCP Server for Rust documentation? The MCP Server is a tool designed to manage, build, and search Rust documentation using cargo doc commands, streamlining the documentation process for developers.

How does the get_crate_doc tool work? The get_crate_doc tool retrieves a crate’s main documentation page, requiring the absolute path to the project and the crate’s name.

Can I list all symbols in a crate’s documentation? Yes, using the list_symbols tool, you can list all symbols, including structs, enums, and traits, within a crate’s documentation.

How do I search within a crate’s documentation? The search_doc tool allows you to search within a crate’s documentation by specifying a search query and the crate’s name. An optional limit parameter can control the number of results returned.

What are the technical requirements for the MCP Server? You need Node.js version 16 or later and Rust and Cargo installed to use the MCP Server effectively.

How can I install the MCP Server? Install the necessary dependencies using pnpm install, then build the server with pnpm run build. For development mode, use pnpm run watch for auto-rebuild functionality.