STARWARCLOUD STARWAR.AI
返回市场
MCP包文档

MCP包文档

作者：sammcj77 星标更新：2025-07-18
安装使用来源：spider==github.com

项目介绍

包文档 MCP 服务器

一个提供多语言包文档高效访问的 MCP（模型上下文协议）服务器，并支持语言服务器协议（LSP）功能。

注意：目前我不再积极维护此代码库。虽然它不提供对私有包文档的访问——Context7 MCP 服务器和服务满足了我的需求，主要是公共包文档。我个人通过我的 mcp-devtools MCP 服务器使用 Context7，该服务器正在积极维护。

功能

  • 多语言支持：

    • 通过 go doc 获取 Go 包文档
    • 通过内置的 help() 获取 Python 库文档
    • 通过注册表文档获取 NPM 包文档（包括私有注册表）
    • 通过 crates.io 和 docs.rs 获取 Rust 软件包文档

  • 智能文档解析：

    • 结构化输出，包括描述、用法和示例
    • 集中信息以避免上下文过载
    • 支持特定符号/函数查找
    • 文档中的模糊和精确搜索能力

  • 高级搜索功能：

    • 在包文档内搜索
    • 模糊匹配以实现灵活查询
    • 带相关性评分的上下文感知结果
    • 从搜索结果中提取符号

  • 语言服务器协议（LSP）支持：

    • 代码符号的悬停信息
    • 代码补全
    • 诊断（错误和警告）
    • 目前支持 TypeScript/JavaScript
    • 可扩展到其他语言

  • 性能优化：

    • 内置缓存
    • 高效解析
    • 最小内存占用

安装

注意：我并不推荐在生产环境中使用 npx -y 来运行你的 MCP 服务器，因为你实际上是在信任从互联网下载的任何包。我强烈建议本地克隆仓库或将其构建到容器镜像中。

npx -y mcp-package-docs

使用

作为 MCP 服务器

  1. 添加到你的 MCP 设置配置：
{
  "mcpServers": {
    "package-docs": {
      "command": "npx",
      "args": ["-y", "mcp-package-docs"],
      "env": {
        "ENABLE_LSP": "true" // 可选：启用语言服务器协议支持
      }
    }
  }
}
  1. LSP 功能包括常见语言服务器的默认配置：
  • TypeScript/JavaScript: typescript-language-server --stdio
  • HTML: vscode-html-language-server --stdio
  • CSS: vscode-css-language-server --stdio
  • JSON: vscode-json-language-server --stdio

如果需要，可以覆盖这些默认设置：

{
  "mcpServers": {
    "package-docs": {
      "command": "npx",
      2. "args": ["-y", "mcp-package-docs"],
      "env": {
        "ENABLE_LSP": "true",
        "TYPESCRIPT_SERVER": "{\"command\":\"/custom/path/typescript-language-server\",\"args\":[\"--stdio\"]}"
      }
    }
  }
}
  1. 服务器提供的工具如下：

lookup_go_doc / describe_go_package

获取 Go 包文档

{
  "name": "describe_go_package",
  "arguments": {
    "package": "encoding/json", // 必需
    "symbol": "Marshal"        // 可选
  }
}

lookup_python_doc / describe_python_package

获取 Python 包文档

{
  "name": "describe_python_package",
  "arguments": {
    "package": "requests",    // 必需
    "symbol": "get"          // 可选
  }
}

describe_rust_package

从 crates.io 和 docs.rs 获取 Rust 软件包文档

{
  "name": "describe_rust_package",
  "arguments": {
    "package": "serde",      // 必需：软件包名称
    "version": "1.0.219"     // 可选：特定版本
  }
}

search_package_docs

在包文档内搜索

{
  "name": "search_package_docs",
  "arguments": {
    "package": "requests",    // 必需：包名称
    "query": "authentication", // 必需：搜索查询
    "language": "python",     // 必需："go", "python", "npm", "swift", 或 "rust"
    "fuzzy": true            // 可选：启用模糊匹配（默认：true）
  }
}

lookup_npm_doc / describe_npm_package

从公共和私有注册表获取 NPM 包文档。根据你的 .npmrc 配置自动使用适当的注册表。

{
  "name": "describe_npm_package",
  "arguments": {
    "package": "axios",      // 必需 - 支持带范围（@org/pkg）和无范围的包
    "version": "1.6.0"       // 可选
  }
}

该工具读取你的 ~/.npmrc 文件以确定每个包的正确注册表：

  • 使用范围注册表配置（例如，@mycompany:registry=...）
  • 支持私有注册表（GitHub Packages, GitLab, Nexus, Artifactory 等）
  • 如果未配置自定义注册表，则回退到默认的 npm 注册表

示例 .npmrc 配置：

registry=https://nexus.mycompany.com/repository/npm-group/
@mycompany:registry=https://nexus.mycompany.com/repository/npm-private/
@mycompany-ct:registry=https://npm.pkg.github.com/

语言服务器协议（LSP）工具

当启用 LSP 支持时，以下额外工具变得可用：

get_hover

获取文档中位置的悬停信息

{
  "name": "get_hover",
  "arguments": {
    "languageId": "typescript", // 必需：语言标识符（例如，"typescript", "javascript"）
    "filePath": "src/index.ts", // 必需：源文件路径
    "content": "const x = 1;",  // 必需：文件内容
    "line": 0,                  // 必需：零基行号
    "character": 6,             // 必需：零基字符位置
    "projectRoot": "/path/to/project" // 可选：项目根目录
  }
}

get_completions

获取文档中位置的补全建议

{
  "name": "get_completions",
  "arguments": {
    "languageId": "typescript", // 必需：语言标识符
    "filePath": "src/index.ts", // 必需：源文件路径
    "content": "const arr = []; arr.",  // 必需：文件内容
    "line": 0,                  // 必需：零基行号
    "character": 16,            // 必需：零基字符位置
    "projectRoot": "/path/to/project" // 可选：项目根目录
  }
}

get_diagnostics

获取文档的诊断信息（错误、警告）

{
  "name": "get_diagnostics",
  "arguments": {
    "languageId": "typescript", // 必需：语言标识符
    "filePath": "src/index.ts", // 必需：源文件路径
    "content": "const x: string = 1;",  // 必需：文件内容
    "projectRoot": "/path/to/project" // 可选：项目根目录
  }
}

在 LLM 中的示例用法

查找文档

// 查找 Go 文档
const goDocResult = await use_mcp_tool({
  server_name: "package-docs",
  tool_name: "describe_go_package",
  arguments: {
    package: "encoding/json",
    symbol: "Marshal"
  }
});

// 查找 Python 文档
const pythonDocResult = await use_mcp_tool({
  server_name: "package-docs",
  tool_name: "describe_python_package",
  arguments: {
    package: "requests",
    symbol: "post"
  }
});

// 查找 Rust 文档
const rustDocResult = await use_mcp_tool({
  server_name: "package-docs",
  tool_name: "describe_rust_package",
  arguments: {
    package: "serde"
  }
});

// 在文档内搜索
const searchResult = await use_mcp_tool({
  server_name: "package-docs",
  tool_name: "search_package_docs",
  arguments: {
    package: "serde",
    query: "serialize",
    language: "rust",
    fuzzy: true
  }
});

// 使用 LSP 获取悬停信息（当启用 LSP 时）
const hoverResult = await use_mcp_tool({
  server_name: "package-docs",
  tool_name: "get_hover",
  arguments: {
    languageId: "typescript",
    filePath: "src/index.ts",
    content: "const axios = require('axios');\naxios.get",
    line: 1,
    character: 7
  }
});

要求

  • Node.js >= 20
  • Go（用于 Go 包文档）
  • Python 3（用于 Python 包文档）
  • 互联网连接（用于 NPM 包文档和 Rust 软件包文档）
  • 语言服务器（用于 LSP 功能）：
    • TypeScript/JavaScript: npm install -g typescript-language-server typescript
    • HTML/CSS/JSON: npm install -g vscode-langservers-extracted

开发

# 安装依赖
npm i

# 构建
npm run build

# 监视模式
npm run watch

贡献

  1. 分叉仓库
  2. 创建你的功能分支 (git checkout -b feature/amazing-feature)
  3. 提交更改 (git commit -m '添加一些精彩的功能')
  4. 推送到分支 (git push origin feature/amazing-feature)
  5. 打开拉取请求

许可证

本项目采用 MIT 许可证 - 详情见 LICENSE 文件。