Yardmcp

🚀 yardmcp

YARDとFastMCPプロトコルを使用して、Rubyのgemドキュメントを探索およびクエリするためのプログラマブルサーバーです。

🚀 クイックスタート

yardmcp は、FastMCPサーバーを介して、RubyのgemとYARDのドキュメントを一連のプログラマブルツールとして公開します。クライアントは、以下の操作が可能です。

• YARDドキュメントを持つインストール済みのgemを一覧表示する
• クラス、モジュール、メソッドを探索する
• ドキュメント、コードスニペット、ソースの場所を取得する
• ドキュメント全体でファジー/全文検索を実行する
• 継承、ミックスイン、関連オブジェクトを調査する

これは、ドキュメントブラウザやコードアシスタントを構築したり、Ruby/YARDのドキュメントを他のシステムに統合する際に便利です。

✨ 主な機能

• gemの一覧表示：YARDドキュメントを持つすべてのインストール済みのgemを表示します。
• クラス/モジュールの一覧表示：gem内のすべてのクラス/モジュールを探索します。
• ドキュメントの取得：任意のクラス/モジュール/メソッドのdocstring、タグ、パラメータ、戻り値の型などを取得します。
• 子要素の一覧表示：名前空間の下にある定数、クラス、モジュール、メソッドを一覧表示します。
• メソッドの一覧表示：クラス/モジュールのすべてのメソッドを一覧表示します。
• 階層構造：継承と包含の情報を取得します。
• 祖先クラス：完全な祖先チェーンを取得します。
• 関連オブジェクト：含まれるモジュール、ミックスイン、サブクラスを見つけます。
• 検索：すべてのドキュメントでファジー/全文検索を行います。
• ソースの場所：任意のオブジェクトのファイルと行番号を見つけます。
• コードスニペット：任意のオブジェクトのソースコードを取得します。

📦 インストール

gemとしてのインストール

gemをローカルでビルドしてインストールすることができます。

gem build yardmcp.gemspec
gem install yardmcp-0.1.0.gem

これにより、yardmcp 実行ファイルがPATHにインストールされます。

💻 使用例

サーバーの起動

サーバーは、長時間実行されるプロセスとして設計されています。起動には時間がかかる場合があります。 起動時には、インストールされたgemのすべてのYARDドキュメントのインデックスを作成するためです。起動中には、進捗状況とログ（Index built ... を含む）が標準エラー出力に表示されます。 クライアントは、標準エラー出力に Index built メッセージが表示されるまで、リクエストを送信しないでください。

サーバーを起動するには、次のコマンドを実行します。

yardmcp

ツールの一覧

以下のツールが利用可能です（tools/list を使用して検出します）。

• ListGemsTool
• ListClassesTool
• GetDocTool
• ChildrenTool
• MethodsListTool
• HierarchyTool
• SearchTool
• SourceLocationTool
• CodeSnippetTool
• AncestorsTool
• RelatedObjectsTool

引数の詳細と戻り値の形式については、lib/yardmcp.rb のコードを参照してください。

🔧 技術詳細

開発

• テストの実行：

  bundle exec rspec
  

  テストスイートは、すべてのテストに対して永続的なサーバープロセスを起動し、サーバーが準備ができるまで待ってからテストを実行します。
• コードスタイル：

  bundle exec rubocop
  

• gemのYARDドキュメントの再生成：

  yard gems <gemname>
  

必要条件

• Ruby 3.2以上
• Bundler
• Gems: fast-mcp, levenshtein, yard, rspec（テスト用）

📄 ライセンス

MITライセンスです。詳細は LICENSE を参照してください。