Yardmcp

🚀 yardmcp

yardmcp 是一個可編程服務器，藉助 YARD 和 FastMCP 協議來探索和查詢 Ruby 寶石（gem）文檔。它為 Ruby 開發者提供了便捷的文檔查詢和探索方式，有助於構建文檔瀏覽器、代碼助手，或把 Ruby/YARD 文檔集成到其他系統中。

🚀 快速開始

yardmcp 通過 FastMCP 服務器將 Ruby 寶石和 YARD 文檔以一組可編程工具的形式呈現。客戶端可以：

• 列出帶有 YARD 文檔的已安裝寶石
• 探索類、模塊和方法
• 獲取文檔、代碼片段和源代碼位置
• 在文檔中進行模糊/全文搜索
• 內省繼承、混入和相關對象

這對於構建文檔瀏覽器、代碼助手，或將 Ruby/YARD 文檔集成到其他系統中非常有用。

✨ 主要特性

• 列出寶石：查看所有帶有 YARD 文檔的已安裝寶石
• 列出類/模塊：探索寶石中的所有類/模塊
• 獲取文檔：獲取任何類/模塊/方法的文檔字符串、標籤、參數、返回類型等
• 列出子項：列出命名空間下的常量、類、模塊和方法
• 列出方法：列出類/模塊的所有方法
• 層次結構：獲取繼承和包含信息
• 祖先鏈：獲取完整的祖先鏈
• 相關對象：查找包含的模塊、混入和子類
• 搜索：在所有文檔中進行模糊/全文搜索
• 源代碼位置：查找任何對象的文件和行號
• 代碼片段：獲取任何對象的源代碼

📦 安裝指南

作為寶石安裝

你可以在本地構建並安裝該寶石：

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

這將把 yardmcp 可執行文件安裝到你的系統路徑中。

💻 使用示例

運行服務器

服務器設計為長期運行的進程。啟動可能需要一些時間，因為它會為已安裝的寶石構建所有 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
  

• 為寶石重新生成 YARD 文檔：

  yard gems <gemname>
  

要求

• Ruby 3.2+
• Bundler
• 寶石：fast-mcp、levenshtein、yard、rspec（用於測試）

📄 許可證

本項目採用 MIT 許可證。詳情請見 LICENSE。