Go Documentation

🚀 godoc - mcp

godoc - mcp はモデルコンテキストプロトコル（MCP）サーバーで、Goドキュメントへの効率的なアクセスを提供します。LLMがGoプロジェクトを理解するのを支援し、ソースファイル全体を読み取ることなく直接パッケージドキュメントを取得できます。これにより、LLMを使用したGo開発のパフォーマンスを大幅に向上させ、単一のパッケージを理解するために必要なトークン数を大幅に削減します。

🚀 クイックスタート

go install github.com/mrjoshuak/godoc-mcp@latest

✨ 主な機能

核心功能

• 自動モジュールコンテキスト処理：GOPATHとGOMODCACHEを手動で設定する必要はありません。サーバーが自動的に一時的なプロジェクトを作成して外部パッケージを解析します。
• 柔軟なドキュメント取得方法：
  • 完全なパッケージドキュメントを取得
  • 特定のシンボル（関数、型など）の詳細情報を表示
  • 未エクスポートのシンボルを表示するオプション
  • ソースコードを表示するオプション

高度な機能

• 複数の作業ディレクトリをサポート：異なるGOPATHとGOMODCACHEを設定することで、複数のプロジェクトを処理できます。
• 効率的なトークナイズ戦略：最適化されたコマンドライン引数により、不要なドキュメントの読み込みを減らします。

💻 使用例

基本的な使用法

Claudeデスクトップアプリに追加する場合：

{
  "mcpServers": {
    # 他のMCPサーバー...
    "godoc": {
      "command": "/path/to/godoc-mcp",
      "args": [],
      "env": {
        "GOPATH": "/path/to/go",
        "GOMODCACHE": "/path/to/go/pkg/mod"
      }
    }
  }
}

高度な使用法

MCPをサポートするLLM（Claudeなど）に接続すると、godoc - mcp は get_doc ツールを提供し、以下のパラメータをサポートします。

• 路径：Goパッケージまたはファイルへのパス（インポートパスまたはファイルパス）
• 目标（オプション）：ドキュメントを取得する特定のシンボル（関数、型など）を指定
• 命令行参数（オプション）：追加のgo docコマンド引数
• 工作目录（オプション）：モジュールを意識したドキュメント取得に使用する特定の作業ディレクトリ（指定されない場合は、一時的なプロジェクトが作成されます）

一般的な 命令行参数 は次のとおりです。

• -all：すべてのドキュメントを表示し、未エクスポートのシンボルは含まない
• -u：未エクスポートのシンボルを表示
• -src：ドキュメントではなくソースコードを表示

📚 ドキュメント

トラブルシューティング

• ローカルパスの場合は、Goソースファイルが含まれているか、Goパッケージを含むディレクトリを指していることを確認してください。
• モジュール関連のエラーが発生した場合は、MCPサーバーの設定で GOPATH と GOMODCACHE 環境変数を正しく設定してください。
• サーバーは自動的に外部パッケージのモジュールコンテキストを処理しますが、特殊な要件がある場合は、特定の 工作目录 を指定できます。

📄 ライセンス

このプロジェクトはMITライセンスの下で提供されています。詳細については、LICENSE ファイルを参照してください。