uptodoc

uptodoc

site icon
2025.04.27 0
TypeScriptIDE 集成AI 代理支持文档查询开发效率
uptodoc 是一个轻量级的 MCP(Model Context Protocol)服务器,专为集成到 IDE 中的 AI 代理(如 GitHub Copilot、Roocode、Cursor、Windsurf)设计。它允许 AI 助手查询自定义的文档数据库,提供更相关和最新的库和框架信息,从而增强编码建议。
View on GitHub

Overview

基本能力

产品定位

uptodoc 是一个轻量级的 MCP 服务器,旨在为 IDE 集成的 AI 代理提供自定义文档查询服务,以增强编码建议的准确性和相关性。

核心功能

  • 实现 Model Context Protocol (MCP),允许 AI 助手查询自定义文档数据库。
  • 提供更相关和最新的库和框架信息。
  • 支持与 GitHub Copilot、Roocode、Cursor、Windsurf 等 AI 代理集成。

适用场景

  • 获取最新或项目特定的文档。
  • 提升 AI 助手在编码建议中的表现。
  • 扩展 Copilot、Roocode、Cursor 或 Windsurf 的自定义知识库。

工具列表

  • npx:用于启动 uptodoc 服务。
  • VSCode:作为 MCP 客户端,支持 uptodoc 的集成。

常见问题解答

  • 如何配置 uptodoc 在 VSCode 中? 在 VSCode 的 settings.json 中添加 MCP 服务器配置,指定 typestdio,并设置 commandargs
  • 如何触发 uptodoc 查询? 在 AI 助手的提示中添加 use uptodoc 以触发查询。

使用教程

使用依赖

  • Node.js 版本 22 或更高。
  • VSCode 版本 1.99.3 或更高(或任何兼容的 MCP 客户端)。

安装教程

uptodoc 不需要全局安装,它会在 IDE 配置正确时自动启动。确保 npx 可用(随 Node.js 安装)。

调试方式

  1. 在 VSCode 中配置 MCP 服务器。
  2. 启动 MCP 服务器。
  3. 在 AI 助手的提示中添加 use uptodoc 以触发查询。

示例命令:

{
  "mcp": {
    "servers": {
      "uptodoc": {
        "type": "stdio",
        "command": "npx",
        "args": ["-y", "@jlgformation/uptodoc", "start"],
        "env": {
          "UPTODOC_ENDPOINT": "https://raw.githubusercontent.com/jlg-formation/uptodoc/master/docs"
        }
      }
    }
  }
}

许可证

该项目遵循 ISC 开源许可条款,请参阅 ISC 了解完整条款。