# @aparte/docs-mcp 中文文档

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

版本：0\.32\.1
npm 元数据更新时间：2026-11-02T11:24:49.437Z
中文译文更新时间：2026-11-06T08:57:15.143Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40aparte/docs-mcp
原文对照：https://npmcn.com/package/%40aparte/docs-mcp/?lang=original
项目主页：https://apartejs.dev/guides/docs-for-agents/
源码仓库：https://github.com/apartejs/aparte

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

- 包体积（解压后）：46.9 kB，11 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=18
- 运行依赖：2 个
- 首次发布：2026-08-29T21:01:01.856Z
- 最新版本发布：2026-11-02T11:24:49.025Z
- 近 30 天下载量：5512（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：46（近 12 个月 46 个）

## 中文简介

作为MCP服务器的相隔文档——一个编码代理搜索向导,读取一页或整个话题(工具与批准,带出自有回路,它们与UI工具包.),总是从相隔.dev中直取出船的版本.

## 安装

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

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

## README

# @aparte/docs-mcp

异地文件作为 **MCP 服务器**,用于写入您的编码代理 一体化。 四个工具——列出主题,搜索,读取一页,读取一整个主题——上 文件网站为模型出版的文本(`apartejs.dev/llms.txt` 及其专题 因此答案总是船的版本文件.

```bash
npx @aparte/docs-mcp
```

这是整个安装一个客户端 生成一个命令。 克劳德代码 :

```bash
claude mcp add aparte-docs -- npx -y @aparte/docs-mcp
```

Claude 桌面 / cursor / 任何拥有 JSON 配置的客户端 :

```json
{ "mcpServers": { "aparte-docs": { "command": "npx", "args": ["-y", "@aparte/docs-mcp"] } } }
```

## 四个工具

| 工具 | 问吧 |
| --- | --- |
| `list_sets` | 文件的题目分成两部分,各一个句子——从这里开始. |
| `search_docs` | 平话排行榜( E)`"approve a tool call"`, (中文(简体) ), `"systemPrompt false"`, (中文(简体) ), `"finish a turn in display-only"`),带有片段. |
| `get_page` | 一页打分,按标题. |
| `get_set` | 一整个话题( 25–250 KB): 工具与批准, 带来自己的循环, 主题与UI 工具包, 提供者, 参考 . |

## 为什么它读网站 而不是捆绑它

每个 `@aparte/*` 在一个版本的包装船和地点部署同一承诺, 因此,“在线文件”是您安装的版本的文档,软件包仍然是 几千字节,没什么好闷的 它需要网络。 用于离线或中转 设置, 服务一个 docs 建立自己, 并指向服务器 :

```bash
APARTE_DOCS_URL=http://localhost:4321 npx @aparte/docs-mcp
```

URL是服务器唯一从中获取的来源 。 它读取的索引列出一个 每个主题的 URL,这些是绝对 生产 URL 即使在本地建筑中——所以 服务器使用他们的 **路径** 问 `APARTE_DOCS_URL` 对于它。 因此,当地建筑是 本地读取, 指定其它主机的索引条目不是请求您的机器 生产。 任何没有决心的 `http`编号 :`https` 被拒绝.

## 嵌入内地

```ts
import { createDocsMcpServer } from '@aparte/docs-mcp';

const server = createDocsMcpServer({ baseUrl: 'https://apartejs.dev' });
// connect it to the transport of your choice (stdio, streamable HTTP…)
```

`DocsSource`, (中文(简体) ), `parseIndex`, (中文(简体) ), `splitPages` 财务报告和审定财务报表 `searchPages` 为主机也输出 想要没有协议的文本.

## 许可证

麻省理工学院

## 常见问题

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

作为MCP服务器的相隔文档——一个编码代理搜索向导,读取一页或整个话题\(工具与批准,带出自有回路,它们与UI工具包\.\),总是从相隔\.dev中直取出船的版本\.

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

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

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

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

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

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

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

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

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

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

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

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

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

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