使用说明

项目简介

Package Docs 是一个 MCP 服务器，旨在增强大型语言模型（LLM）理解和处理代码的能力。它通过提供对各种编程语言的软件包文档和语言服务器协议（LSP）功能的访问，为 LLM 应用提供丰富的上下文信息。

主要功能点

• 多语言文档支持：支持 Go 语言包（通过 'go doc'）、Python 库（通过内置 'help()'）和 NPM 包（包括公共和私有仓库）的文档查询。
• 智能文档解析：结构化输出文档信息，包括描述、用法和示例，并支持精确和模糊搜索。
• 高级搜索功能：支持在包文档内搜索，提供模糊匹配和相关性评分。
• 语言服务器协议 (LSP) 支持：提供代码符号悬停信息、代码补全和诊断功能，目前支持 TypeScript/JavaScript，并可扩展到其他语言。
• 性能优化：内置缓存、高效解析和最小内存占用。

安装步骤

1. 确保已安装 Node.js (>= 20)、Go 和 Python 3 环境。如果需要 LSP 功能，请根据仓库 README 安装相应的语言服务器（如 TypeScript Language Server）。
2. 使用 npm 安装 Package Docs MCP 服务器：

   npx -y mcp-package-docs
   

服务器配置 (MCP 客户端配置)

在 MCP 客户端的服务器配置中，添加 Package Docs 服务器的启动信息。以下是一个示例配置，您需要将其添加到 MCP 客户端的配置文件中：

{
  "mcpServers": {
    "package-docs": {
      "command": "npx",  // 启动服务器的命令，这里使用 npx
      "args": ["-y", "mcp-package-docs"], // 命令参数，-y 表示自动确认安装，mcp-package-docs 是要执行的包名
      "env": {
        "ENABLE_LSP": "true" // 可选环境变量：设置为 "true" 以启用语言服务器协议 (LSP) 支持
      }
    }
  }
}

基本使用方法

成功配置并启动 Package Docs MCP 服务器后，您可以在 LLM 应用中通过 MCP 协议调用服务器提供的工具。

• 使用 'lookup_go_doc'、'lookup_python_doc'、'lookup_npm_doc' 工具查询特定包或符号的文档。
• 使用 'search_package_docs' 工具在文档中搜索特定内容。
• 如果启用了 LSP 支持，可以使用 'get_hover'、'get_completions' 和 'get_diagnostics' 工具获取代码悬停信息、代码补全建议和诊断信息。

请参考仓库的 README 文件和工具定义，了解更详细的工具参数和使用方法。