Godoc MCP Server

🚀 godoc-mcp-server

Go言語のパッケージとそのドキュメントをpkg.go.devから検索し、情報をLLMに提供するMCPサーバーです。

🚀 クイックスタート

godoc-mcp-serverは、Go言語のパッケージ情報をpkg.go.devから取得し、LLMに提供する役割を果たします。以下に、インストールと使用方法を説明します。

📦 インストール

以下の2つの方法でgodoc-mcp-serverをインストールできます。

方法1: リリースページからダウンロード

リリースページ から事前にコンパイルされたバイナリファイルをダウンロードできます。

方法2: ソースコードからインストール

以下のコマンドを使用して、ソースコードからインストールして自分でコンパイルできます。

go install github.com/yikakia/godoc-mcp-server/cmd/godoc-mcp-server@latest

💻 使用例

基本的な使用法

クライアントを使用してリクエストを送信するだけです。このサーバーは標準入出力で動作します。

📋 今後の予定

ローカルキャッシュ

• [x] 毎回の検索を避けるためにローカルキャッシュを使用する（Redditのユーザーからの提案）

パッケージ検索

• [x] パッケージが他のパッケージによってインポートされている数を取得する

パッケージ情報の取得

• [ ] サンプルを取得する

リリース

• [x] GitHub Actionsを使用して複数のプラットフォーム向けにリリースする

📚 ドキュメント

開発の経験

説明は非常に重要です。パラメータを説明する際には、クライアントがあるツールの出力を使用して別のツールの入力形式を変更する方法を伝える必要があります。

例えば、searchPackage の出力にはサブパッケージ名が含まれますが、パッケージ名は含まれません。したがって、LLMに getPackageInfo を使用してサブパッケージの情報を取得させる場合、packageName パラメータに以下の説明を記述しました。

検索するパッケージの名前です。以前にsearchPackagesを使用し、ユーザーがサブパッケージの情報を取得したい場合、それらを組み合わせる必要があります。例えば、ユーザーがmcpを検索すると、packageName: github.com/mark3labs/mcp-go/mcpとサブパッケージclientが返されます。ユーザーがclientの情報を取得したい場合、packageNameをgithub.com/mark3labs/mcp-go/mcp/clientに設定する必要があります。

この詳細な説明を使用すると、LLMはサブパッケージの名前を提供します。ユーザーは直接取得したいパッケージの情報を指定することができ、LLMはそれらを組み合わせて getPackageInfo を呼び出して情報を取得します。

したがって、ユーザーにこの説明を設定させることで、ツールをより有用かつ効率的にすることができます。

ライブラリの使用

このモジュールがエクスポートするGo APIは現在、不安定であり、破壊的な変更が加えられる可能性があります。将来的に安定性を提供する予定です。ご使用例については、問題を提出してフィードバックを送ってください。

📄 ライセンス

このプロジェクトはMITオープンソースライセンスの下でライセンスされています。完全な条項については、MIT を参照してください。