Docs.rs

🚀 貨物ドキュメントMCPサーバー

このサーバーは、cargo docコマンドを通じてRustドキュメントを管理するためのMCPサーバーです。これにより、ローカルのRustドキュメントのチェック、構築、検索が可能になります。

✨ 主な機能

ツール

• get_crate_doc - crateのメインドキュメントページを取得し、全体的な概念と使い方を理解するために使用します。

  • パラメータ:
    • project_path: プロジェクトのパス（絶対パスで指定する必要があります）
    • crate_name: ドキュメントを取得するcrateの名前

• list_symbols - crateのドキュメント内のすべてのシンボル（構造体、列挙型、トレイトなど）をリスト表示します。

  • パラメータ:
    • project_path: プロジェクトのパス（絶対パスで指定する必要があります）
    • crate_name: シンボルをリストするcrateの名前

• search_doc - crateのドキュメント内で内容を検索します。

  • パラメータ:
    • project_path: プロジェクトのパス（絶対パスで指定する必要があります）
    • crate_name: 検索対象のcrateの名前
    • query: 検索クエリ（キーワードまたはシンボル）
    • limit（オプション）: 返される結果の最大数（デフォルト: 10）

📦 インストール

必要条件

• 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サーバーは標準入出力を通じて通信するため、デバッグは難しい場合があります。MCP Inspectorの使用をおすすめします。

pnpm run inspector

Inspectorは、ブラウザでアクセスできるデバッグツールのURLを提供します。

キャッシュシステム

このサーバーは、パフォーマンス向上のために構築済みのドキュメントパスのキャッシュを維持しています。キャッシュエントリは24時間後に期限切れになり、ドキュメントが最新の状態を保つようになっています。

📄 ライセンス

MIT