Go Documentation

🚀 godoc - mcp

godoc-mcp 是一個模型上下文協議（MCP）服務器，可提供高效的 Go 文檔訪問。它能助力 LLM 理解 Go 項目，無需讀取整個源文件，即可直接獲取包文檔，極大提升使用 LLM 進行 Go 開發的性能。

🚀 快速開始

使用以下命令安裝 godoc-mcp：

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

✨ 主要特性

核心功能

• 自動模塊上下文處理：服務器會自動創建臨時項目來解析外部包，無需手動配置 GOPATH 和 GOMODCACHE。
• 靈活的文檔獲取方式：
  • 可獲取完整包文檔。
  • 能查看特定符號（函數、類型等）的詳細信息。
  • 支持可選顯示未導出符號。
  • 支持可選顯示源代碼。

高級功能

• 支持多工作目錄：可通過配置不同的 GOPATH 和 GOMODCACHE 來處理多個項目。
• 高效的分詞策略：通過優化的命令行參數減少不必要的文檔加載。

📦 安裝指南

使用以下命令安裝最新版本的 godoc-mcp：

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

💻 使用示例

基礎用法

在 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：顯示源代碼而不是文檔

📚 詳細文檔

為什麼選擇 godoc - mcp？

一句話概括：godoc-mcp 以更高效的分詞方式提供 Go 文檔訪問。

通過直接獲取包文檔，LLM 可以：

• 快速理解代碼結構
• 精準定位 API 使用方法
• 敏銳洞察設計模式

故障排除

• 對於本地路徑，請確保其包含 Go 源文件或指向包含 Go 包的目錄。
• 如果出現模塊相關錯誤，請在 MCP 服務器配置中正確設置 GOPATH 和 GOMODCACHE 環境變量。
• 服務器會自動處理外部包的模塊上下文，但如果您有特殊需求，仍可提供特定的 工作目錄。

📄 許可證

該項目採用 MIT 許可證，詳細信息請參閱 LICENSE 文件。

項目狀態徽章