MCP Docs Sync

MCP文档知识

提供方 anirbankundu-pc

文档知识 未标注 无需鉴权 社区 / 第三方 ClaudeVS Code

一个自动将OpenAPI规范同步到Mintlify文档的MCP服务器,支持自动和手动同步,并提供OpenAPI规范验证功能。

一句话选型结论

按资料字段整理

MCP Docs Sync 属于文档知识类 MCP 服务器,传输方式未标注,无需鉴权,可直接接入 Claude、VS Code,没有现成安装命令,需按官方文档接入。接入前先确认权限范围;涉及写入、删除或付款的操作,建议先在测试环境验证。

分类文档知识 传输方式未标注 鉴权无需鉴权 部署方式未标注
GitHub 星标 0 仓库热度,无公开仓库时显示未标注
工具数 5 暴露给模型的工具数量
资源 / 提示词 0 / 0 资源与提示词模板数量
维护方 社区 / 第三方 核验等级 仅资料核对

工具与能力

文档知识
数量来自来源目录的标注,具体工具清单以官方文档为准
工具数量5暴露给模型可调用的工具个数
资源数量0可读取的资源条目
提示词数量0内置提示词模板数量

能力标签

支持客户端

适用场景

文档同步JavaScript本地部署OpenAPIMintlifyMCP协议API文档

安装与配置

未标注 无需鉴权
上游未给出传输方式
  1. 1
    准备运行环境

    按官方文档确认运行环境(常见为 Node.js 或 Python),装好后再执行安装命令。

  2. 2
    安装服务

    复制上面的安装命令执行;命令里带占位符的位置,换成自己的密钥或路径。

  3. 3
    写入客户端配置

    在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,让新配置生效。

  4. 4
    验证是否可用

    连接成功后客户端会列出约 5 个工具,随便调一个只读工具确认能返回结果。

典型使用场景

3 类
按分类与标签整理的常见用法,具体以官方文档为准
文档检索问答

在你的文档库里按问题找答案。

知识库读写

把新资料写进知识库,随用随取。

内容整理

把零散资料归纳成结构化笔记。

选择建议

选之前先看这几条
按条目字段给出的判断,不替你决定用不用

值得选的地方

  • 资料标注 5 个工具,职责相对集中,接入后不容易误操作。
  • 已适配 Claude、VS Code,换客户端不用重新研究配置。
  • 资料标注无需鉴权,装好就能连。

先想清楚的地方

  • 没有现成安装命令,需要按官方文档自己填启动命令和参数。
  • 版本更新与行为细节以官方仓库为准。

更适合

  • 需要在文档知识场景里让模型直接调用外部能力的人。
  • 已经在用 Claude、VS Code 的用户,接入路径最短。
  • 想先快速试一下、能接受在本地或自有环境跑服务的人。

不太适合

  • 需要厂商级 SLA 和技术支持的生产环境。

同类对比

6 个同类
同分类里挑最接近的几条,字段以各自详情页为准
MCP 服务器工具数传输方式部署方式安装命令最后核验
MCP Docs Sync当前 5 未标注 未标注 无 2026-05-17
dify 未标注 stdio · 本地进程 本地部署 有 2026-04-11
open-webui 未标注 stdio · 本地进程 本地部署 有 2026-04-11
JeecgBoot 未标注 stdio · 本地进程 本地部署 有 2026-04-11
Cherry Studio 未标注 未标注 未标注 无 2026-05-17
mempalace 未标注 stdio · 本地进程 本地部署 有 2026-04-11

服务器档案

文档知识
字段来自项目仓库与公开索引,中文说明由本站标注
提供方anirbankundu-pc上游标注的维护方 anirbankundu-pc
分类文档知识本站按上游分类展示
连接方式未标注上游未给出传输方式
鉴权方式无需鉴权远程服务建议用最小权限凭据
维护方社区 / 第三方核验等级 仅资料核对
包名 / 运行时未标注 · 未标注本地安装时用到的包标识与运行时
部署类型未标注上游给出的部署形态
最近核验2026-05-17上游最后核验时间

详细介绍

6.2 KB
来自项目仓库与上游目录的原文,未做删改

MCP文档同步服务器

一个模型上下文协议(MCP)服务器,可以自动将OpenAPI规范与Mintlify文档同步。

特性

  • 自动同步:关注OpenAPI规范的变化并同步到Mintlify
  • 手动同步:手动更新的一次性同步命令
  • 验证:同步前验证OpenAPI规范
  • MCP集成:为人工智能助手提供管理文档的工具

安装```bash

cd mcp-docs-sync
npm install


## 用法

### 1.观看模式(推荐)

OpenAPI规范更改时自动同步:```bash
npm run watch

这将:

  • 执行初始同步
  • 注意更改 openapi.json 和 openapi.yaml
  • 检测到更改时自动同步
  • 继续运行,直到按下Ctrl+C

2.手动同步

执行一次性同步:```bash
npm run sync


### 3.MCP服务器模式

运行HTTP MCP服务器进行AI助手集成(VS Code、Claude等):```bash
npm start

这将在以下位置启动HTTP端点 http://localhost:3003/mcp (用覆盖 PORT).你的 mcp.json 应使用:```jsonc
{
"servers": {
"docs-sync-server": {
"url": "http://localhost:3003/mcp",
"type": "http"
}
}
}


如果您更喜欢stdio(命令)传输,请更改 `index.js` 回到 `runStdio()` 或者创建一个单独的条目文件并配置:```jsonc
{
"servers": {
"docs-sync-server": {
"type": "command",
"command": "node",
"args": ["./index.js"]
}
}
}

它做什么

同步时,MCP服务器:

  1. 倒像 OpenAPI规范来自 user-api/openapi.json
  2. 副本 它到 procore-connect-docs/api-reference/user-api-openapi.json
  3. 更新 这 docs.json 配置
  4. 更新 包含最新信息的介绍页
  5. 添加 同步时间戳以跟踪更改

MCP工具(HTTP和Stdio)

健康终点(非MCP)

服务器还公开了一个简单的监控路由:

GET /health → 返回JSON:```jsonc
{
"status": "ok",
"timestamp": "2025-11-04T12:34:56.000Z",
"server": "docs-sync-server",
"version": "1.0.1",
"tools": ["sync_openapi", "get_openapi_info", "validate_openapi", "health", "search"]
}


将其用于外部探测或容器编排就绪检查。

服务器为AI助手提供了五个MCP工具:

### `sync_openapi`

将OpenAPI规范同步到Mintlify文档。

输入(可选):```json
{
"force": false
}

force 可以在将来用于跳过更改检测(目前是占位符)。

get_openapi_info

获取当前OpenAPI规范的摘要详细信息。

退货:```jsonc
{
"title": "string",
"version": "string",
"description": "string",
"servers": [ { "url": "..." } ],
"pathCount": 42,
"schemaCount": 10
}


### `validate_openapi`

验证OpenAPI规范和表面错误和警告。

退货:```jsonc
{
"valid": true,
"errors": ["..."],
"warnings": ["..."],
"spec": { /* original spec */ }
}

health

MCP服务器的简单健康检查。

退货:```jsonc
{
"status": "ok",
"timestamp": "2025-11-04T12:34:56.000Z",
"server": "docs-sync-server",
"version": "1.0.1"
}


### `search`

搜索Mintlify文档页面和同步的OpenAPI规范。

输入:```jsonc
{
"query": "user permissions",
"maxResults": 15,            // optional (default 25)
"includeOpenApi": true,      // optional (default true)
"includePages": true         // optional (default true)
}

退货:```jsonc
{
"tool": "search",
"query": "user permissions",
"elapsedMs": 42,
"totalMatches": 31,
"truncated": true,
"results": [
{
"type": "page",
"source": "api-reference/user-api/introduction.mdx#paragraph-3",
"snippet": "…Permissions enable fine-grained access control…",
"score": 2.14,
"metadata": {
"file": "api-reference/user-api/introduction.mdx",
"paragraphIndex": 3
}
},
{
"type": "openapi",
"source": "openapi://GET/users/{id}/permissions",
"snippet": "GET /users/{id}/permissions\nReturns the effective permissions for a user…",
"score": 2.7,
"metadata": {
"method": "GET",
"path": "/users/{id}/permissions",
"operationId": "getUserPermissions"
}
}
]
}


笔记:

- 匹配目前是简单的子字符串搜索(不区分大小写)。
- 页面结果为段落级别;OpenAPI结果为操作级别。
- `score` 是一种结合了发生次数和接近度的启发式方法。
- 未来的改进可能包括模糊匹配和排名(见建议部分)。

### 调用工具(示例)

在启用MCP的客户端中,您可以请求:```
Call the `validate_openapi` tool.
Then call `sync_openapi` with {"force": true}.

配置

编辑 config.js 要自定义路径和设置,请执行以下操作:```javascript
export const config = {
// Paths
userApiPath: '../user-api',
mintlifyDocsPath: '../procore-connect-docs',

// Watch settings
watchPaths: ['../user-api/openapi.json', '../user-api/openapi.yaml'],

// ... more settings
};


## 与用户API集成

MCP服务器与您的用户API项目集成:```
code/
├── user-api/              # Your API
│   ├── openapi.json       # Generated OpenAPI spec (watched)
│   └── openapi.yaml       # Alternative format (watched)
├── procore-connect-docs/  # Mintlify docs
│   └── api-reference/
│       ├── user-api-openapi.json  # Synced spec
│       └── user-api/              # API documentation pages
└── mcp-docs-sync/         # This server
└── ...

工作流程

典型开发流程:

  1. 开始观看模式 在一个终端中:```bash
    cd mcp-docs-sync
    npm run watch

1. **更新API** 带有新端点或更改的代码

1. **重新启动用户API** (重新生成OpenAPI规范):```bash
cd user-api
npm start
  1. MCP服务器检测到更改 并自动同步到Mintlify

  2. Mintlify自动重新加载 更新文档

故障排除

同步不工作?

  1. 检查路径 config.js 是正确的
  2. 确保 openapi.json 存在于用户api文件夹中
  3. 检查文件权限
  4. 在控制台中查找错误消息

监视模式未检测到更改?

  1. 确保你正在保存文件
  2. 尝试手动同步: npm run sync
  3. 检查监视路径 config.js 是正确的

脚本

命令 描述
npm start 运行MCP服务器(用于AI集成)
npm run watch 监视模式-更改时自动同步
npm run sync 手动一次性同步
npm run dev 手表模式的别名

依赖项

  • @modelcontextprotocol/sdk -用于AI集成的MCP SDK
  • chokidar -文件监视
  • chalk -终端颜色

许可证

国际学生委员会

常见问题

6 问
答案由本站依据条目字段整理,不引用上游原文
MCP Docs Sync 怎么安装?

资料没有给出安装命令,请到官方仓库或文档按说明接入;这类条目多数是生态应用,或尚未发布可安装包。

MCP Docs Sync 怎么在 Claude、VS Code 里配置?

它的传输方式未标注,在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,配置才会生效。

MCP Docs Sync 收费吗?

本站不代收费用,也没有标注具体价格。是否收费取决于服务本身和背后的接口额度,正式使用前按官方说明确认。

MCP Docs Sync 需要 API Key 吗?

资料标注为无需认证,装好就能连;如果实际调用时报鉴权错误,按官方文档补上凭据。

MCP Docs Sync 支持哪些客户端?

资料标注支持 Claude、VS Code;其他客户端只要能配置 MCP Server,也能用同样的命令或地址接入。

MCP Docs Sync 能提供哪些能力?

资料显示约 5 个工具;能力标签包括 API集成、JavaScript、Claude、API文档。具体工具清单以官方文档为准。

热门专题

按标签挑服务器
全部专题 →

服务器信息以作者仓库与官方文档为准;分类、传输方式与鉴权方式的中文说明为中文整理,最近核验 2026-05-17。