@aparte/docs-mcp

中文文档
0.32.1发布于 2026/11/02MITTypeScriptES Module构建来源已验证近 30 天下载 5512

The aparté documentation as an MCP server — a coding agent searches the guides, reads a page or a whole topic (tools & approval, bring your own loop, theming & the UI kit…), always the version that ships, straight from apartejs.dev.

原始使用文档
文档目录4 节
  1. The four tools
  2. Why it reads the site rather than bundling it
  3. Embedding it
  4. License

@aparte/docs-mcp

The aparté documentation as an MCP server, for the coding agent that is writing your integration. Four tools — list the topics, search, read a page, read a whole topic — over the text the docs site publishes for models (apartejs.dev/llms.txt and its per-topic files), so the answer is always the docs of the version that ships.

npx @aparte/docs-mcp

That is the whole install for a client that spawns a command. Claude Code:

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

Claude Desktop / Cursor / any client with a JSON config:

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

The four tools

ToolAsk it for
list_setsThe topics the docs are split into, one sentence each — start here.
search_docsPages ranked for plain words ("approve a tool call", "systemPrompt false", "finish a turn in display-only"), with a snippet.
get_pageOne page's markdown, by title.
get_setA whole topic at once (25–250 KB): tools & approval, bring your own loop, theming & the UI kit, providers, reference.

Why it reads the site rather than bundling it

Every @aparte/* package ships at one version and the site deploys from the same commit, so "the docs online" are the docs of the version you installed — and the package stays a few kilobytes with nothing to go stale. It needs the network. For an offline or staging setup, serve a docs build yourself and point the server at it:

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

That URL is the only origin the server ever fetches from. The index it reads lists one URL per topic, and those are absolute production URLs even in a local build — so the server takes their path and asks APARTE_DOCS_URL for it. A local build is therefore read locally, and an index entry naming some other host is not a request your machine makes. Anything that does not resolve to http/https is refused.

Embedding it

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 and searchPages are exported too, for a host that wants the text without the protocol.

License

MIT

版本与发布记录

@aparte/docs-mcp 共发布 46 个版本,首次发布于 2026/08/30;过去 12 个月发布了 46 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.32.1latest2026/11/024 天前
0.32.02026/11/024 天前
0.31.02026/11/024 天前
0.30.12026/11/014 天前
0.30.02026/11/014 天前
0.29.42026/11/015 天前

其他发布通道:alpha → 0.17.0。

关于 @aparte/docs-mcp 的常见问题

@aparte/docs-mcp 是什么?

The aparté documentation as an MCP server — a coding agent searches the guides, reads a page or a whole topic (tools & approval, bring your own loop, theming & the UI kit…), always the version that ships, straight from apartejs.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 和提交记录判断。