Skip to main content
Glama
spacemeowx2

Cargo Doc MCP Server

by spacemeowx2

货物文档 MCP 服务器

一个 MCP 服务器,用于通过 Cargo doc 命令管理 Rust 文档。该服务器提供本地检查、构建和搜索 Rust 文档的工具。

特征

工具

  • get_crate_doc - 获取 crate 的主文档页面,以了解整体概念和用法

    • 参数:

      • project_path :Rust 项目的路径(必须是绝对路径)

      • crate_name :获取文档的包的名称

  • list_symbols - 列出包文档中的所有符号(结构、枚举、特征等)

    • 参数:

      • project_path :Rust 项目的路径(必须是绝对路径)

      • crate_name :列出符号的包的名称

  • search_doc - 在板条箱的文档中搜索

    • 参数:

      • project_path :Rust 项目的路径(必须是绝对路径)

      • crate_name :要搜索的包的名称

      • query :搜索查询(关键字或符号)

      • limit (可选):返回的最大结果数(默认值:10)

Related MCP server: MCP Rust Docs Server

要求

  • Node.js 16 或更高版本

  • Rust 和 Cargo 安装

安装

安装依赖项:

pnpm install

构建服务器:

pnpm run build

对于使用自动重建的开发:

pnpm run watch

用法

添加以下配置:

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

调试

由于 MCP 服务器通过 stdio 进行通信,调试起来可能比较困难。我们建议使用 MCP Inspector:

pnpm run inspector

检查器将提供一个 URL 来访问浏览器中的调试工具。

缓存系统

服务器会维护已构建文档路径的缓存,以提高性能。缓存条目会在 24 小时后过期,以确保文档保持最新状态。

执照

麻省理工学院

Available Tools

3 tools
get_crate_docA

Get crate's main documentation page. Useful for unresolved imports (e.g. use get_crate_doc when seeing 'unresolved import tokio::sync') or understanding crate features.

ParametersJSON Schema
NameRequiredDescriptionDefault
project_pathYesPath to the Rust project (must be absolute path)
crate_nameYesName of the crate to get documentation for

TDQS

A4.1/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden. It mentions the tool's purpose and use cases but lacks details on behavioral traits such as error handling, response format, or any constraints like rate limits or authentication needs. This leaves gaps in understanding how the tool behaves beyond its basic function.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is appropriately sized and front-loaded, with two sentences that directly state the purpose and provide usage guidance without any wasted words. Each sentence adds value, making it efficient and well-structured.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's moderate complexity (2 parameters, no output schema, no annotations), the description covers purpose and usage well but lacks details on behavioral aspects and output. Without annotations or an output schema, it should ideally provide more context on what to expect from the tool's response, leaving it somewhat incomplete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already documents both parameters ('project_path' and 'crate_name') with clear descriptions. The description does not add any additional meaning or context about the parameters beyond what the schema provides, resulting in a baseline score of 3.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the specific action ('Get crate's main documentation page') and resource ('crate'), distinguishing it from sibling tools like 'list_symbols' and 'search_doc' by focusing on retrieving primary documentation rather than listing symbols or searching within documentation.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It explicitly provides when to use this tool ('Useful for unresolved imports... or understanding crate features') with a concrete example ('e.g. use get_crate_doc when seeing 'unresolved import tokio::sync''), effectively guiding the agent on appropriate contexts without mentioning alternatives, which is sufficient for clear usage.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

list_symbolsB

List all symbols in a crate. Use when implementing traits or exploring available types. Shows structs, enums, traits with their paths.

ParametersJSON Schema
NameRequiredDescriptionDefault
project_pathYesPath to the Rust project (must be absolute path)
crate_nameYesName of the crate to list symbols for

TDQS

B3.1/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden of behavioral disclosure. It mentions what the tool shows (structs, enums, traits with paths), but doesn't cover critical aspects like whether it's read-only, safe, requires specific permissions, handles errors, or provides pagination/formatting details. For a tool with zero annotation coverage, this is a significant gap in transparency.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is appropriately sized and front-loaded, with two sentences that efficiently convey purpose and usage. It avoids unnecessary details, though it could be slightly more structured (e.g., separating purpose from guidance). Overall, it's concise with minimal waste.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (2 parameters, no output schema, no annotations), the description is incomplete. It lacks information on behavioral traits (e.g., safety, error handling), output format, and explicit usage boundaries. Without annotations or an output schema, the description should do more to compensate, but it falls short.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema description coverage is 100%, with both parameters ('project_path' and 'crate_name') fully documented in the schema. The description doesn't add any parameter-specific details beyond what the schema provides, such as format examples or constraints. This meets the baseline for high schema coverage, but doesn't enhance understanding.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose with a specific verb ('List') and resource ('symbols in a crate'), and distinguishes the types of symbols included (structs, enums, traits with paths). However, it doesn't explicitly differentiate from sibling tools like 'get_crate_doc' or 'search_doc', which prevents a perfect score.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides implied usage guidance ('Use when implementing traits or exploring available types'), which gives some context for when to invoke the tool. However, it lacks explicit guidance on when not to use it or alternatives (e.g., compared to 'search_doc'), and doesn't mention prerequisites like needing a valid Rust project, leaving room for improvement.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

search_docB

Search crate docs for specific features, error messages, or usage examples. Helps debug compilation issues or learn new APIs.

ParametersJSON Schema
NameRequiredDescriptionDefault
project_pathYesPath to the Rust project (must be absolute path)
crate_nameYesName of the crate to search in
queryYesSearch query (keyword or symbol)

TDQS

B3.1/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden of behavioral disclosure. It mentions the tool's purpose and use cases but fails to describe key behavioral traits like whether it requires specific permissions, how results are returned (e.g., format, pagination), or any rate limits. This leaves significant gaps for an agent to understand how to invoke it effectively.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is concise and well-structured in two sentences: the first states the purpose, and the second provides usage context. There is no wasted text, and it is front-loaded with the core functionality. However, it could be slightly more efficient by integrating the use cases more seamlessly.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the complexity of a search tool with 3 parameters, no annotations, and no output schema, the description is incomplete. It lacks details on behavioral aspects (e.g., result format, error handling) and doesn't compensate for the absence of structured output information, making it insufficient for an agent to fully understand the tool's operation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema has 100% description coverage, providing clear details for all three parameters (project_path, crate_name, query). The description adds no additional parameter semantics beyond what the schema already states, such as examples of valid queries or constraints on crate names. With high schema coverage, the baseline score of 3 is appropriate as the schema handles the heavy lifting.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose: 'Search crate docs for specific features, error messages, or usage examples.' It specifies the verb ('Search') and resource ('crate docs'), and mentions the target content types. However, it doesn't explicitly differentiate from sibling tools like 'get_crate_doc' or 'list_symbols', which likely have related but distinct functions.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides implied usage guidance by stating it 'Helps debug compilation issues or learn new APIs,' suggesting contexts where this tool is appropriate. However, it lacks explicit guidance on when to use this tool versus its siblings (e.g., 'get_crate_doc' and 'list_symbols'), such as comparing search functionality to direct documentation retrieval or symbol listing.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

  1. 3 tool updates
    • First observedget_crate_doc
    • First observedlist_symbols
    • First observedsearch_doc

TDQS

A3.6/5.0

Scored across 3 tools

Disambiguation5/5

Each tool has a clearly distinct purpose: get_crate_doc retrieves main documentation pages, list_symbols enumerates all symbols in a crate, and search_doc performs targeted searches within documentation. There is no overlap in functionality, making it easy for an agent to select the appropriate tool based on the task.

Naming Consistency5/5

All tool names follow a consistent verb_noun pattern (get_crate_doc, list_symbols, search_doc) with clear, descriptive verbs. There are no deviations in naming conventions, making the tool set predictable and easy to understand.

Tool Count3/5

With only 3 tools, the server feels somewhat thin for a documentation-focused domain, as it might lack operations like updating or managing documentation. However, the tools cover core use cases, so it's borderline but not severely mismatched.

Completeness4/5

The tools provide good coverage for basic documentation tasks: retrieving main docs, listing symbols, and searching. Minor gaps exist, such as no direct support for navigating between documentation sections or handling version-specific docs, but agents can likely work around these limitations.

Maintenance

ActivityInactive
ResponsivenessNo issues

Related MCP Connectors

Related MCP Servers