mcpField
U
uptodoc

uptodoc

本地服务
github.com/jlg-formationAI 与智能体179 周前更新
代码仓库

关于 uptodoc

uptodoc 是本地 MCP 服务，供 IDE 集成的 AI Agent 查询可配置的文档库，适合需要获取较新或项目专属库与框架文档的编码场景。

主要功能

  1. 01查询文档库
  2. 02配置文档端点
  3. 03接入 IDE 内的 AI 助手

适用场景

  1. 01检索较新的库文档
  2. 02为编码建议补充项目专属知识

MCP 相关

它以本地服务实现 MCP，向兼容的 MCP 客户端提供文档查询。

配置

本地服务的配置在各客户端中通用，复制后粘贴到客户端的 MCP 配置文件即可。

mcp.json · 通用配置
{
  "mcpServers": {
    "uptodoc": {
      "command": "npx",
      "args": [
        "-y",
        "@jlgformation/uptodoc"
      ],
      "env": {
        "UPTODOC_ENDPOINT": "<UPTODOC_ENDPOINT>"
      }
    }
  }
}
启动命令npx -y @jlgformation/uptodoc
需要配置的环境变量
UPTODOC_ENDPOINT

本地服务需要在你的电脑上安装运行环境（如 Node.js 18+）。各客户端的配置文件位置不同，请参考客户端文档。

安装包
npm@jlgformation/uptodoc

工具

1

收录的工具列表 · 更新于 3 周前

参数类型必填说明
librarystring是库名称。

详细介绍

uptodoc

一个轻量级 MCP（Model Context Protocol）服务，适用于集成在 IDE 中的 AI Agent （例如 GitHub Copilot、Roocode、Cursor、Windsurf）。

概述

uptodoc 提供了一个实现 Model Context Protocol （MCP）的本地服务。
它允许集成在 VSCode 等 IDE 中的 AI 助手查询自定义文档数据库，从而获取关于库和框架的更相关、更新的信息。

在 IDE 中完成配置后，助手会自动与 uptodoc 通信，以提升代码建议的质量。

典型用例：

  • 获取更新或特定于项目的文档
  • 改进编码助手提供的 AI 建议
  • 为 Copilot、Roocode、Cursor 或 Windsurf 扩展自定义知识

要求

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

使用 uptodoc 前，请确保已安装这些工具并将其更新到最新版本。

安装

无需全局安装 uptodoc。
配置正确后，IDE 会自动启动它。

请确保系统中可以使用 npx（它随 Node.js 一起提供）。

注意：该软件包必须以 @jlgformation/uptodoc 这个名称发布在 npm 上。

IDE 配置

如需在 VSCode 中使用 uptodoc，请将以下内容添加到设置中（例如， .vscode/settings.json）：

{
  // rest of the user settings.json config.
  "mcp": {
    "servers": {
      "uptodoc": {
        "type": "stdio",
        "command": "npx",
        "args": ["-y", "@jlgformation/uptodoc", "start"],
        "env": {
          "UPTODOC_ENDPOINT": "https://<yoursite.org>/<path>"
        }
      }
    }
  }
}

将 Github Copilot AI 助手设为 agent mode。然后在 vscode 中启动 MCP 服务。

现在你应该可以与 AI 助手交流了。请随时在提示词中加入神奇短语：use uptodoc。

示例：

I want to install the tototructruc library. How to do ? use uptodoc.

如上所示，可以配置文档的端点。默认值为：

UPTODOC_ENDPOINT=https://raw.githubusercontent.com/jlg-formation/uptodoc/master/docs

还有一些糟糕的文档： https://github.com/jlg-formation/uptodoc/tree/master/docs

参考资料

作者

Jean-Louis GUENEGO [email protected]

评论

支持 Markdown

第一次接触 MCP？

从协议是什么，到在客户端里装上第一个服务，这几条回答覆盖了大多数入门问题。

一个开放协议，规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话，MCP 服务负责提供工具、资源和提示模板，两者通过标准消息通信，同一个服务可以被不同客户端复用。