Apideck Docs MCP 软件
Apideck 开发者文件 • 妇女 报名 • 妇女 开发者指南 • 妇女 更改日志
编码代理从他们对API的记忆中写出集成代码,记忆会变质. Apideck Docs MCP 允许代理在工作时查找当前文件 。 把它指向Markdown的文件夹 它给了代理三个工具, search_docs, (中文(简体) ), get_doc 财务报告和审定财务报表 list_docs,用于 Claude 代码、 Cursor 和 Claude 桌面,或用于主机端点的超流式 HTTP .
我们运行它为 Apideck 开发者docs https://developers.apideck.com/mcp。将您的代理连接到那里,它可以在构建时阅读我们的会计指南,包括:
您可以从 npm 安装为 @apideck/docs-mcp,然后作为 CLI 运行,将它作为Vercel 函数部署,或者将其挂载在现有的节点或Next.js站点内。 这个 docs/ 此 repo 中的文件夹持有样本内容和服务器自己的文档。 开始 文件/索引.md。 。 。 .
快开始
pnpm install
pnpm run audit --docs ./docs # find broken links, thin pages and stale content
pnpm run search vercel --docs ./docs # query the index from your terminal
pnpm run start --docs ./docs # MCP over stdio
pnpm run serve --docs ./docs --port 3000 # MCP over HTTP at http://localhost:3000/mcp
留着 run数字 : audit 财务报告和审定财务报表 search 也是内置的 pnpm 命令,所以 pnpm audit 运行pnpm自己的安全审计 而不是这次.
构建一次( O)pnpm build)和 docs-mcp 二进制中 dist/bin/ 不使用 tsx 操作相同的命令 .
连接 Claude 代码
claude mcp add my-docs -- docs-mcp start --docs /path/to/docs --base-url https://docs.example.com
或犯下 .mcp.json 在文件旁边:
{
"mcpServers": {
"my-docs": {
"command": "docs-mcp",
"args": ["start", "--docs", "./docs", "--base-url", "https://docs.example.com", "--about", "the Example API reference"]
}
}
}
图标
| 命令 | 它会做什么 |
|---|---|
docs-mcp start | MCP过 stdio。 文件更改上的再索引( E)--watch 默认情况下 ). |
docs-mcp serve --port 3000 | MCP超流式HTTP,与Vercel函数相同的处理器. |
docs-mcp audit | 报告断开的链接,薄或空的页面,僵化的页面,缺少标题/描述,重复标题,标题跳出和超长的段落. 1号出错. |
docs-mcp search "query" | 从终端搜索索引. |
共享旗帜 : --docs, (中文(简体) ), --base-url, (中文(简体) ), --about, (中文(简体) ), --name。每个回归到 DOCS_DIR, (中文(简体) ), DOCS_BASE_URL, (中文(简体) ), DOCS_ABOUT, (中文(简体) ), DOCS_NAME。 。 。 .
工具
search_docs(query, limit?, path_prefix?):有标题和标题助推,前缀和模糊相配等标题级全文搜索,每页最多点击三次.get_doc(path, section?):全页下标有页眉和节大纲,或一节及其分节.path也接受完整的 URL.list_docs(path_prefix?, limit?): 有标题、描述、字数和最后修改日期的页面.
每个页面也是 MCP 资源 docs://<path>。完整参考: 文件/工具(md)。 。 。 .
日志工具调用
过 onToolCall 改为 createServer 或者说 createHttpHandler 以获得工具,论据,时间,结果计数以及每一次呼叫的呼叫者. search_docs 电话 resultCount: 0 你的医生不能回答的问题 Vercel 函数记录每个调用作为 JSON 线 DOCS_LOG_TOOL_CALLS=1。见 文件/工具(md)。 。 。 .
浏览器代理的 WebMCP
@apideck/docs-mcp/webmcp 注册服务器的工具,加 read_current_page,与 document.modelContext 因此浏览器代理调用工具而不是刮取:
import { registerDocsTools } from '@apideck/docs-mcp/webmcp'
registerDocsTools({ endpoint: '/mcp' })
它在浏览器中没有WebMCP(目前Chrome 149+在旗下或原产地试验后)的功能. 见 文件/网页。 。 。 .
在Vercel上进行托管
api/mcp.ts 是无国籍的可流式HTTP函数; vercel.json 重写 /mcp 将它和捆绑 docs/** 与函数。 设定 DOCS_BASE_URL 财务报告和审定财务报表 DOCS_ABOUT 在项目环境和部署中。 详细情况 文件/东道主,md。 。 。 .
用作图书馆
把处理器挂入一个已经建起文件的站点,所以端点就住在它们旁边. A Next.js 页面路由 API 路由 :
// src/pages/api/mcp.ts
import { createHttpHandler, DocStore } from '@apideck/docs-mcp'
import type { NextApiRequest, NextApiResponse } from 'next'
import path from 'path'
const store = new DocStore({ root: path.join(process.cwd(), 'public', 'md'), baseUrl: 'https://docs.example.com' })
const handler = createHttpHandler({ store, name: 'example-docs', about: 'the Example API documentation' })
export const config = { maxDuration: 60, api: { responseLimit: false } }
export default (req: NextApiRequest, res: NextApiResponse) => handler(req, res)
添加 experimental.outputFileTracingIncludes: { '/api/mcp': ['./public/md/**/*'] } 改为 next.config 所以在Vercel上有功能的减速船. DocStore 还需要一个 metadata(path) 用钩子从构建的列表中提供标题、描述和条形URL,以及 get_doc 接受完整的URL以及路径。 过 instructions 将针对主机的指南附加到每个客户端在连接上被告知的内容中,例如何时推荐一个相伴的 MCP 服务器(文件/工具(md)) (中文(简体) ). 过 extraTools 改为 createServer编号 :createHttpHandler 添加特定主机工具(API操作索引,覆盖矩阵,.),同时添加三个内置工具——见 文件/工具(md)。出口: DocStore, (中文(简体) ), createServer, (中文(简体) ), createHttpHandler, (中文(简体) ), createDocTools, (中文(简体) ), toolResult, (中文(简体) ), READ_ONLY, (中文(简体) ), auditDocs, (中文(简体) ), formatAuditReport, (中文(简体) ), createStore, (中文(简体) ), resolveConfig, (中文(简体) ), normalizePath, (中文(简体) ), sectionUrl, (中文(简体) ), tokenize· ; registerDocsTools 从 @apideck/docs-mcp/webmcp。 。 。 .
SDK v2 迁移 (0. 3. 0)
见 移徙说明 用于更新公共SDK类型, 运输默认和释放/采用指导。 SDK v2在0.3.0中发运. 已编制0.4.1 HTTP 运输补救 直接宣布补丁的节点适配器 这样清洁的消费者就能继承它.
发展
pnpm typecheck
pnpm lint
pnpm test # builds first; covers parsing, indexing, audit, HTTP, compiled CLI and public types
pnpm test:package # packs and verifies a clean installed consumer without overrides
pnpm build
布局镜像 @apideck/mcp数字 : src/ 为图书馆, bin/ 为立体CLI, api/ 对于Vercel函数,测试合用 *.test.ts。 。 。 .
如何运作
- 每个
.md编号 :.mdx编号 :.markdown文档根下的文件被读取,前题解析,身体在 ATX 标题上被分拆(遵守代码栅栏). - 每个部分都成为MiniSearch索引中的文档,其中
title, (中文(简体) ),heading, (中文(简体) ),content财务报告和审定财务报表path字段. - 查询会先用所有需要的名词运行,会倒回任何名词,所以一个打字不会返回任何名词.
- 单位
start财务报告和审定财务报表serve,一个递归性文件监视器在上次更改后重建了索引300 ms. 在 Vercel 上,每个函数实例创建一次索引,每个部署更新一次.
许可证
麻省理工学院