# @apideck/docs-mcp 中文文档

规范地址：https://npmcn.com/package/%40apideck/docs-mcp/

版本：0\.4\.1
npm 元数据更新时间：2026-10-12T04:20:26.420Z
中文译文更新时间：2026-11-06T10:09:23.747Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40apideck/docs-mcp
原文对照：https://npmcn.com/package/%40apideck/docs-mcp/?lang=original
项目主页：https://github.com/apideck-libraries/docs-mcp#readme
源码仓库：https://github.com/apideck-libraries/docs-mcp

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：177 kB，57 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：7 个
- 首次发布：2026-09-12T14:24:50.760Z
- 最新版本发布：2026-10-12T04:20:26.037Z
- 近 30 天下载量：4129（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：4（近 12 个月 4 个）

## 中文简介

MCP 服务器允许代理在查询时间搜索和检索您的文档,而不是依赖 Stale 训练数据 .

## 安装

```sh
npm install @apideck/docs-mcp
```

也可以使用：`pnpm add @apideck/docs-mcp`、`yarn add @apideck/docs-mcp`、`bun add @apideck/docs-mcp`

## README

# Apideck Docs MCP 软件

[Apideck 开发者文件](https://developers.apideck.com/) • 妇女 [报名](https://www.apideck.com/signup) • 妇女 [开发者指南](https://developers.apideck.com/guides) • 妇女 [更改日志](https://developers.apideck.com/changelog)

编码代理从他们对API的记忆中写出集成代码,记忆会变质. Apideck Docs MCP 允许代理在工作时查找当前文件 。 把它指向Markdown的文件夹 它给了代理三个工具, `search_docs`, (中文(简体) ), `get_doc` 财务报告和审定财务报表 `list_docs`,用于 Claude 代码、 Cursor 和 Claude 桌面,或用于主机端点的超流式 HTTP .

我们运行它为 Apideck 开发者docs `https://developers.apideck.com/mcp`。将您的代理连接到那里,它可以在构建时阅读我们的会计指南,包括:

-   [应付账款自动化](https://developers.apideck.com/guides/accounts-payable-automation)
-   [应收账款自动化](https://developers.apideck.com/guides/accounts-receivable-automation)
-   [银行种子](https://developers.apideck.com/guides/bank-feeds)
-   [商业贷款](https://developers.apideck.com/guides/business-lending-accounting-api)
-   [收债](https://developers.apideck.com/guides/debt-collections-accounting-api)
-   [支出管理](https://developers.apideck.com/guides/expense-management-integration)
-   [FP&A:预算编制、预测和差异报告](https://developers.apideck.com/guides/fpa-with-accounting-api)
-   [FX付款和已实现损益](https://developers.apideck.com/guides/fx-payments-accounting-api)
-   [薪金日记账项](https://developers.apideck.com/guides/payroll-journal-entries)
-   [采购](https://developers.apideck.com/guides/procurement-accounting-api)
-   [税务自动化](https://developers.apideck.com/guides/tax-automation-accounting-api)

您可以从 npm 安装为 `@apideck/docs-mcp`,然后作为 CLI 运行,将它作为Vercel 函数部署,或者将其挂载在现有的节点或Next.js站点内。 这个 `docs/` 此 repo 中的文件夹持有样本内容和服务器自己的文档。 开始 [文件/索引.md](https://npmcn.com/package/%40apideck/docs-mcp/docs/index.md)。 。 。 .

## 快开始

```bash
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 代码

```bash
claude mcp add my-docs -- docs-mcp start --docs /path/to/docs --base-url https://docs.example.com
```

或犯下 `.mcp.json` 在文件旁边:

```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)](https://npmcn.com/package/%40apideck/docs-mcp/docs/tools.md)。 。 。 .

## 日志工具调用

过 `onToolCall` 改为 `createServer` 或者说 `createHttpHandler` 以获得工具,论据,时间,结果计数以及每一次呼叫的呼叫者. `search_docs` 电话 `resultCount: 0` 你的医生不能回答的问题 Vercel 函数记录每个调用作为 JSON 线 `DOCS_LOG_TOOL_CALLS=1`。见 [文件/工具(md)](https://npmcn.com/package/%40apideck/docs-mcp/docs/tools.md#logging-tool-calls)。 。 。 .

## 浏览器代理的 WebMCP

`@apideck/docs-mcp/webmcp` 注册服务器的工具,加 `read_current_page`,与 `document.modelContext` 因此浏览器代理调用工具而不是刮取:

```ts
import { registerDocsTools } from '@apideck/docs-mcp/webmcp'
registerDocsTools({ endpoint: '/mcp' })
```

它在浏览器中没有WebMCP(目前Chrome 149+在旗下或原产地试验后)的功能. 见 [文件/网页](https://npmcn.com/package/%40apideck/docs-mcp/docs/webmcp.md)。 。 。 .

## 在Vercel上进行托管

`api/mcp.ts` 是无国籍的可流式HTTP函数; `vercel.json` 重写 `/mcp` 将它和捆绑 `docs/**` 与函数。 设定 `DOCS_BASE_URL` 财务报告和审定财务报表 `DOCS_ABOUT` 在项目环境和部署中。 详细情况 [文件/东道主,md](https://npmcn.com/package/%40apideck/docs-mcp/docs/hosting.md)。 。 。 .

## 用作图书馆

把处理器挂入一个已经建起文件的站点,所以端点就住在它们旁边. A Next.js 页面路由 API 路由 :

```ts
// 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)](https://npmcn.com/package/%40apideck/docs-mcp/docs/tools.md#adding-host-instructions)) (中文(简体) ). 过 `extraTools` 改为 `createServer`编号 :`createHttpHandler` 添加特定主机工具(API操作索引,覆盖矩阵,.),同时添加三个内置工具——见 [文件/工具(md)](https://npmcn.com/package/%40apideck/docs-mcp/docs/tools.md#extending-the-server-with-host-specific-tools)。出口: `DocStore`, (中文(简体) ), `createServer`, (中文(简体) ), `createHttpHandler`, (中文(简体) ), `createDocTools`, (中文(简体) ), `toolResult`, (中文(简体) ), `READ_ONLY`, (中文(简体) ), `auditDocs`, (中文(简体) ), `formatAuditReport`, (中文(简体) ), `createStore`, (中文(简体) ), `resolveConfig`, (中文(简体) ), `normalizePath`, (中文(简体) ), `sectionUrl`, (中文(简体) ), `tokenize`· ; `registerDocsTools` 从 `@apideck/docs-mcp/webmcp`。 。 。 .

## SDK v2 迁移 (0. 3. 0)

见 [移徙说明](https://npmcn.com/package/%40apideck/docs-mcp/docs/migrating-to-sdk-v2.md) 用于更新公共SDK类型, 运输默认和释放/采用指导。 SDK v2在0.3.0中发运. 已编制0.4.1 [HTTP 运输补救](https://npmcn.com/package/%40apideck/docs-mcp/docs/http-transport-security.md) 直接宣布补丁的节点适配器 这样清洁的消费者就能继承它.

## 发展

```bash
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`。 。 。 .

## 如何运作

1.  每个 `.md`编号 :`.mdx`编号 :`.markdown` 文档根下的文件被读取,前题解析,身体在 ATX 标题上被分拆(遵守代码栅栏).
2.  每个部分都成为MiniSearch索引中的文档,其中 `title`, (中文(简体) ), `heading`, (中文(简体) ), `content` 财务报告和审定财务报表 `path` 字段.
3.  查询会先用所有需要的名词运行,会倒回任何名词,所以一个打字不会返回任何名词.
4.  单位 `start` 财务报告和审定财务报表 `serve`,一个递归性文件监视器在上次更改后重建了索引300 ms. 在 Vercel 上,每个函数实例创建一次索引,每个部署更新一次.

## 许可证

麻省理工学院

## 常见问题

### @apideck/docs-mcp 是什么？

MCP 服务器允许代理在查询时间搜索和检索您的文档,而不是依赖 Stale 训练数据 \.

### 如何安装 @apideck/docs-mcp？

在项目目录运行 npm install @apideck/docs-mcp，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 docs-mcp，可以用 npx docs-mcp 直接运行。

### @apideck/docs-mcp 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @apideck/docs-mcp 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @apideck/docs-mcp 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @apideck/docs-mcp 可以商用吗？

@apideck/docs-mcp 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @apideck/docs-mcp 的下载量有多少？

根据 npm 官方下载统计，@apideck/docs-mcp 在 2026/10/06 – 2026/11/04 这 30 天内被下载 4,129 次，日均约 138 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @apideck/docs-mcp 还在维护吗？

最新版本 0\.4\.1 发布于 2026/10/12（26 天前）；至今共发布 4 个版本，其中过去 12 个月发布了 4 个；首次发布于 2026/09/12。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。