MCP Package Docs

🚀 包文檔工具使用指南

包文檔工具是一款強大的工具，它能助力開發者迅速獲取各類編程語言庫和框架的文檔信息，極大提升開發效率。

✨ 主要特性

• 多語言文檔支持：涵蓋Go、Python、Rust等主流編程語言的包/庫文檔，滿足不同開發者的需求。
• 智能搜索：可在指定語言包文檔中進行全文檢索，讓你快速找到所需信息。
• 語言服務器協議（LSP）集成：提供代碼高亮、自動補全和錯誤檢測功能，增強開發體驗。

📦 安裝指南

必備依賴

• Node.js：版本要求 >= 20。
• Go：用於生成Go語言的文檔。
• Python 3：用於生成Python語言的文檔。
• 互聯網連接：獲取NPM包文檔和Rust crate文檔需要網絡。

可選依賴（用於LSP功能）

npm install -g typescript-language-server typescript vscode-langservers-extracted

💻 使用示例

安裝工具

npm install package-docs

常用命令

• 初始化項目：package-docs init
• 生成文檔：package-docs build
• 開發模式：package-docs dev

基礎用法

獲取包文檔

• Go語言包

const goDocResult = await useMCPTool({
    serverName: "包文檔",
    toolName: "描述Go包",
    arguments: {
        包名: "encoding/json", 
        符號名: "Marshal"
    }
});

• Python語言包

const pythonDocResult = await useMCPTool({
    serverName: "包文檔",
    toolName: "描述Python包",
    arguments: {
        包名: "requests", 
        函數名: "post"
    }
});

• Rust語言庫

const rustDocResult = await useMCPTool({
    serverName: "包文檔",
    toolName: "描述Rust包",
    arguments: {
        包名: "serde"
    }
});

文檔內容檢索

const searchResult = await useMCPTool({
    serverName: "包文檔",
    toolName: "搜索包文檔",
    arguments: {
        包名: "serde", 
        查詢詞: "序列化",
        語言: "rust",
        模糊匹配: true
    }
});

高級用法

LSP功能示例

• 懸停提示

const hoverResult = await useMCPTool({
    serverName: "包文檔",
    toolName: "獲取懸停信息",
    arguments: {
        語言標識符: "typescript",
        文件路徑: "src/index.ts",
        文件內容: "const axios = require('axios');\naxios.get",
        行號: 1,
        列數: 7
    }
});

• 代碼補全

const completionsResult = await useMCPTool({
    serverName: "包文檔",
    toolName: "獲取代碼補全",
    arguments: {
        語言標識符: "typescript",
        文件路徑: "src/index.ts", 
        文件內容: "const arr = []; arr.",
        行號: 0,
        列數: 8
    }
});

• 錯誤檢測

const errorsResult = await useMCPTool({
    serverName: "包文檔",
    toolName: "獲取錯誤信息",
    arguments: {
        語言標識符: "typescript",
        文件路徑: "src/index.ts", 
        文件內容: "function foo() { console.log('bar'); }"
    }
});

📚 詳細文檔

開發指南

項目結構

package-docs/
├── src/                 # 源代碼目錄
│   ├── core/           # 核心邏輯模塊
│   ├── lsp/            # LSP協議實現模塊
│   └── utils/         # 工具函數模塊
└── docs/               # 文檔資料

開發流程

1. 克隆倉庫：git clone https://github.com/yourusername/package-docs.git
2. 安裝依賴：npm install
3. 啟動開發環境：npm run dev

操作說明

• 初始化項目：運行package-docs init創建基本配置文件。
• 構建文檔：使用package-docs build生成目標語言的文檔信息。
• 啟動服務：通過package-docs start開始提供文檔服務。
• 日誌查看：相關操作日誌位於./logs/目錄下。

⚠️ 注意事項

⚠️ 重要提示

使用前請確保已安裝所有依賴項。

💡 使用建議

• 代碼示例僅供參考，實際使用時需根據項目需求調整。
• 如有自定義擴展，請參考擴展文檔進行開發。