# @appsoftwareltd/etherpk-mcp 中文文档

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

版本：0\.20\.0
npm 元数据更新时间：2026-11-06T16:04:05.135Z
中文译文更新时间：2026-11-06T16:04:28.117Z
软件包许可：Elastic-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40appsoftwareltd/etherpk-mcp
原文对照：https://npmcn.com/package/%40appsoftwareltd/etherpk-mcp/?lang=original
项目主页：https://docs.etherpk.com/using-ai-agents-with-your-notes
源码仓库：https://github.com/appsoftwareltd/etherpk-client

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

- 包体积（解压后）：23.7 MB，411 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=24
- 运行依赖：24 个
- 首次发布：2026-09-15T18:56:30.293Z
- 最新版本发布：2026-11-06T16:04:04.756Z
- 近 30 天下载量：4763（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：56（近 12 个月 56 个）

## 中文简介

EtherPK 无头客户端:一个通过同步知识图的MCP服务器,运行在用户自己机器上的代理机旁.

## 安装

```sh
npm install @appsoftwareltd/etherpk-mcp
```

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

## README

# @ appsoftwaretd/ etherpk- mcp

[![Discord](https://img.shields.io/badge/Discord-join%20the%20community-5865F2?logo=discord&logoColor=white)](https://discord.gg/m9vScxQzvp)

一个 [MCP 磁共振](https://modelcontextprotocol.io/) 提供 AI 代理服务器( Claude 代码、 代码、 光标) 你们的其中之一 [以太平板电脑](https://etherpk.com/) 知识图. 它运行在代理的 电脑 代理可以按单词或含义搜索您的笔记,跟随链接,列表任务,以及 在不突破以太PK格式的情况下读取并编辑文档.

这个包是以太PK的 **无头客户端**,没有编辑器的以太PK. 它提供图表文件夹 通过同步服务器同步的计算机或图表,两者都有相同的工具。 受保护 从未向代理人显示文件,甚至姓名也不显示; `graph_info` 只数他们.

需要节点.js 24或以后.

## 开始吧

### 同步图

在以太平板电脑中,打开图表 **设置 – 代理** 选择 **创建代理设置代码**标签显示 用您的服务器、 代码和填入的图表 命令 。 在您的同步服务器上, 标签 链接到服务器 **访问令牌** 页面,它使代码.

```sh
# Once per computer. When this terminal and EtherPK, on a device where your Encryption Keys are
# unlocked, show the same code, approve there, then press y here.
npx @appsoftwareltd/etherpk-mcp login --sync-server https://sync.etherpk.com --code <Agent Setup Code>

# Register the graph with your agent (Claude Code shown, the Agents tab has the others).
claude mcp add --scope user etherpk -- npx @appsoftwareltd/etherpk-mcp serve --sync-server https://sync.etherpk.com --graph <graph id>
```

### 本地图形文件夹

没有签名和同步服务器 :

```sh
claude mcp add --scope user etherpk -- npx @appsoftwareltd/etherpk-mcp serve --folder /path/to/your/notes
```

文件夹必须是 EtherPK 图形, 带有 `pages/` 财务报告和审定财务报表 `journals/` 文件夹在里面。 以太平板电脑 当它打开一个文件夹时,它们就变成这样 [代理技能](https://npmcn.com/package/%40appsoftwareltd/etherpk-mcp/#readme-the-agent-skill) 把它们变成一个新的 一个. **设置 – 代理** 一旦设置了文件夹的路径, 则用所填路径显示此命令 在总帐上.

### 问你的笔记

服务器向代理商描述了其工具和图表,因此不需要其他设置. 改为: 让经纪人总是使用它们, 在您身上添加这样一行 `CLAUDE.md`或者你的经纪人 等量:

> 我的笔记被保存在以太PK. 我写下来的任何东西都用这个工具 `search` 在提问的语义模式中.

## 探员能做的

36个工具,用于同步图和文件夹。 每个 `serve` 服务于一个图表,以及 没有工具显示受保护的文档: 读取的答案, 如没有这样的文档, 并写入 它的名字被拒绝.

| 组 | 工具 | 页:1 |
| --- | --- | --- |
| 查找并读取 | `graph_info`, (中文(简体) ), `list_documents`, (中文(简体) ), `read_document`, (中文(简体) ), `read_documents`, (中文(简体) ), `search`, (中文(简体) ), `backlinks`, (中文(简体) ), `tasks`, (中文(简体) ), `graph_insights`, (中文(简体) ), `graph_path` | `list_documents` 可以缩小为一系列日记日. `graph_insights` 列出最有关联的概念、集群和桥梁,以及 `graph_path` 找出两个概念之间的关联. |
| 编辑 | `edit_document`, (中文(简体) ), `append_document`, (中文(简体) ), `create_page`, (中文(简体) ), `set_task`, (中文(简体) ), `set_frontmatter`, (中文(简体) ), `set_aliases` | `edit_document` 替换一个准确、独特的文本,在同步图上,它与别处的编辑合并. `append_document` 创建当日的日记条目. |
| 移交的任务 | `read_task`, (中文(简体) ), `add_task_note`, (中文(简体) ), `set_task` | 粘贴代理文本 **复制代理指令** 在以太平板电脑中复制。 它的引用仍然发现在上方添加行后的任务,并在任务词变后拒绝. |
| 重命名 | `plan_rename`, (中文(简体) ), `rename` | 与旧名的链接被改写. 重命名到使用中的名称会合并两个文档并需要确认 . |
| 图像和文件 | `upload_asset`, (中文(简体) ), `read_asset`, (中文(简体) ), `list_assets` | `upload_asset` 返回标记下粘贴到文档中。 还有 `read_asset` 报告图像的大小,该行将图像放入绘图状态。 它拒绝隐藏的文件和文件夹( Q)`.ssh`, (中文(简体) ), `.env`),无头客户端自己的配置和缓存,以及超过100个米B的文件. |
| 出版 | `list_publications`, (中文(简体) ), `create_publication`, (中文(简体) ), `update_publication`, (中文(简体) ), `publish` | `publish` 写入带有 `publish` 命令。 代理无法选择一个,它从不发布到一个 GitHub 寄存器,它只有 `publish` 命令承诺. |
| 主题 | `list_themes`, (中文(简体) ), `read_theme`, (中文(简体) ), `read_theme_file`, (中文(简体) ), `create_theme`, (中文(简体) ), `customise_publication_theme`, (中文(简体) ), `write_theme_file`, (中文(简体) ), `delete_theme_file`, (中文(简体) ), `import_theme_folder`, (中文(简体) ), `delete_theme`, (中文(简体) ), `preview_theme` | 捆绑的主题只读取,并自定义一个拷贝入图. `preview_theme` 生成一个站点,在设置浏览器时会显示截图. |

同步图的工具从这台计算机的复制中解答. 虽然副本无法到达同步服务器, 从什么时候起,每个回答都以一个音符结尾 `graph_info` 报告 `connection`编辑 从那时起,别处没有答案.

`read_asset`, (中文(简体) ), `read_theme` 财务报告和审定财务报表 `preview_theme` 仅在图表中写入 `downloads` 文件夹中 缓存目录,和 `import_theme_folder` 只读从那里。 外面的文件夹被拒绝了, 因此隐藏在笔记中的提示不能引导代理书写或阅读到别处.

## 一个图上的几个特工

任何数量的特工可以一次使用一个图表. 第一个 `serve` 对于图形开始背景 和每个 `serve` 把经纪人的要求交给它 所以有一个 复制内存中的图表和一张磁盘上的索引.

-   代理会话即起. 一个在图表打开之前被调用的工具等待它.
-   过程保存了图表, 并在最后的代理人离开5分钟后停止 (单位:千美元)`ETHERPK_MCP_HOST_IDLE_SECONDS`) (中文(简体) ). 一个仍然连接的代理在其下一个请求中开始一个新的.
-   `running` 以他们的代理人和日志列出进程,以及 `stop` 结束他们.
-   如果程序在请求期间停止,代理人被告知请求可能已经或可能已经停止 应用。 一个从未达到的要求会进入下一个过程.
-   没有要送达的图表( 没有登录, 或尚未登录的文件夹) , 代理商将保留 连接和每个工具的答案 `graph_unavailable` 与缘由. 请求10秒或 以后再尝试,所以修复原因不需要重启.
-   进程日志为 `host.log` 在图表的缓存目录中. `publish` 运行在相同的 进程.

## 按含义搜索

`search` 匹配单词。 经过一个设置步骤,它也符合意义, 所以"我何时交税" 找到写"1月31日到期"的纸条 一个小型嵌入模型运行在这个计算机上。 没什么 ,而受保护的文档从未嵌入.

```sh
npx @appsoftwareltd/etherpk-mcp semantic setup
```

设置将本地运行时间( 通过您的 npm) 和23 MB 模型安装到缓存中 目录,每台电脑一次.

-   **没有重启 .** 一个图的背景过程每30秒检查一次,然后开始嵌入一次 设置已经运行。 在此之前,拒绝按意义进行搜索,消息将设置命令命名.
-   **模式.** `search` 带 `mode: "semantic"`,或 `"hybrid"` 为了文字和意义在一起。 每个 结果有文件、标题和母子弹的面包屑、通过和 相似分数.
-   **进步.** 第一次通过一个大图表需要几分钟,然后在背景中运行. 之后 只有更改的文档被嵌入。 成果报告 `embedded`, (中文(简体) ), `total` 财务报告和审定财务报表 `complete`,以及 `semantic status` 显示每个缓存图表.
-   **当其行相.** 仅当图的背景过程运行时, 也就是当一个代理程序运行时 5分钟后打开图表 要保持没有代理的图表流, 请运行 `npx @appsoftwareltd/etherpk-mcp serve --graph <id> </dev/null &` (或 `--folder <path>`) (中文(简体) ).
-   **装入.** 模型使用四分之一的核心,最多4个,暂停10分之一秒 在批次之间. `ETHERPK_MCP_SEMANTIC_THREADS` 更改线程数。 装入代理机 登记 `env`。 。 。 .
-   **每个探员.** `serve --no-semantic` 只保留一个注册文本.

## 同步图表

### 签名于

`login` 让这台电脑成为你的账户设备.

-   **标志.** `--code` 交易代理设置代码 一个代理托肯。 在 以太极PK的代理设置( Graphs 页的) **探员** 选项卡,或同步的图表 **设置 − 探员**),或同步服务器上 **访问令牌** 页面中,将符号列表为 "特工上线" 代理符号可以读取和写出您的图表. 这个 无法重置或替换您的加密密钥、 制作令牌、 邀请人或删除图表 。 这个 在未使用30天后停止工作,当您取消时停止工作,当您重新设置您的加密密钥时停止工作.
-   **脚本**, (中文(简体) ), `--pat` 或者说 `ETHERPK_PAT` 给出一个全账户访问符. `login` 用它解锁,然后把它换成一个Token探员,然后撤销它。 如果交换失败了, `login` 失败了 什么都不保留.
-   **钥匙** 由设备批准解锁。 在账户所在的浏览器中打开 EtherPK 加密密钥已解锁 。 当浏览器和终端显示相同的短代码时,请选择 **核准** 在浏览器中并按下 `y` 在终端。 新闻 `n` 如果代码不同.
-   **没有以太PK手**按钮 `r` 时 `login` 等待或通过 `--recovery-code`类型 您的复苏代码. `ETHERPK_RECOVERY_CODE` 用于脚本设置.

`login` 然后列出账户所能到达的图表.

### 选择一个图表

`graphs` 列出每个登录账户能够到达的同步图表,其中包含名称、id和您的 角色。 。 . `serve --graph` 取出身份证或名字. `(unnamed)` 表示一个图表还没有名字.

### 多个同步服务器

运行 `login` 每个同步服务器一次. `--sync-server` 然后说命令意味着哪个服务器。 这个 可以在只有一个服务器签名的情况下被忽略.

## 本地文件夹

-   文件夹必须保存 `pages/` 财务报告和审定财务报表 `journals/`。 。 。 . `serve` 从不创造它们,所以错误的路径是 而不是变成一个空的图表.
-   用编辑器或由代理直接撰写文件制作的编辑器,在下次编辑之前被取出 工具调用,索引在一秒左右内随行.
-   当工具返回时,工具的写入文件. 向代理商报告失败的写入和 在下次写作时重审.
-   索引保存在缓存目录中,从未保存在文件夹中. 移动或重命名文件夹 启动新索引.

## 发布网站

`publish` 将一张图表输入此计算机的文件夹并打印报告:

```sh
npx @appsoftwareltd/etherpk-mcp publish --graph <id or name> --publication <id> --out <dir>
```

-   `--out` 这份图表和出版物被人们记住。 之后没有它,代理的 `publish` 工具,写入同一文件夹.
-   高层 `.html` 文档, `assets/`, (中文(简体) ), `theme/` 并重写搜索和输入文件, 并删除不再属于的文件。 文件夹里的其他东西都留下.
-   文件夹必须是自己的,在图表文件夹外. 一个出版商拒绝了图表 文件夹, 里面的文件夹和持有它的文件夹, 因为它会删除图表的文件 .
-   `--dry-run` 替换 `--out` 制作和检查出版物并印刷整份报告, 上面写着它提到的网页名称,没有写任何东西。 它不需要文件夹。 留着它 输出出公共日志。 经纪人的 `publish` 工具带 `dryRun: true` 同样的支票.
-   部署文件夹由你决定。 运行命令 从克龙为一个站点 重排自己.
-   美人鱼图,地图和Excalidraw图需要浏览器. 地图作为图片公布 地图,从 EtherPK 地图主机上绘制,除非 `ETHERPK_MAP_STYLE_URL` 名称另一个样式,和 a 画成一个图,里面有它的字体. `diagrams setup` 安装约170 MB 的铬 进入缓存目录,每台电脑一次, 以及一个其页面持有其中任何一个拒绝的发布 直到那时. `ETHERPK_CHROMIUM` 名称 : 电脑,NixOS需要的.
-   `list_publications`,或 **设置 – 发布** 在以太平板电脑中,显示出版物编号.

直接发布到 GitHub 寄存器的分库, 由主机监听 分支部署,给 `--github` 替换 `--out`,带有可读取和写入 仓库内容 :

```sh
ETHERPK_GITHUB_TOKEN=<token> npx @appsoftwareltd/etherpk-mcp publish --graph <id or name> --publication <id> --github <owner/name[#branch]>
```

-   树枝是 `main` 除非 `#branch` 又一个名字。 出版社从不创建分支.
-   `--github` 被替换为文件夹, 所以以后运行只需要符号 .
-   一种改变什么也不做承诺的刊物。 第一次发布到一个已经拥有的分支 其他文件列出将替换和停止的文件,以及 `--replace` 无论如何,出版.
-   经纪人的 `publish` 工具从不承诺寄存器, 因为承诺可以放置网站 活着 它可以检查出版物 `dryRun: true`。 。 。 .

## 代理技能

这个 `etherpk` 代理技能在 EtherPK 的博客、 Docs 网站或wiki 文件夹中教导代理 在任意工程中的格式,以 `publish --dry-run`,并以此出版 命令。 对于同步的图表,它发送代理到上面的工具. 在工程中安装 代理人在工作或与 `-g` 每个项目:

```sh
npx skills add appsoftwareltd/etherpk-client
```

## 参考文献

每个命令都是 `npx @appsoftwareltd/etherpk-mcp <command>`简而言之, `etherpk-mcp`, (中文(简体) ), 在全球安装软件包一次 `npm install -g @appsoftwareltd/etherpk-mcp`。 。 。 . `--help` (单位:千美元)`-h`)打印命令引用并 `--version` (单位:千美元)`-v`) 该版本.

### 图标

| 命令 | 它会做什么 |
| --- | --- |
| `login --sync-server <url> [--code <Agent Setup Code>] [--recovery-code]` | 将此计算机作为您的账户设备签名, 解锁您的加密密钥, 并列出账户所能到达的图表 . |
| `graphs [--sync-server <url>]` | 列出每个登录账户可以到达的同步图表,其中包含名称,id和您的角色. |
| `serve --graph <id or name> [--sync-server <url>] [--no-semantic]` | 给特工提供一张同步图表. |
| `serve --folder <path> [--no-semantic]` | 以同样的方式提供本地的图表文件夹 . |
| `running` | 列出这台计算机上所服务的图表,其中包含每个人的背景过程,代理和日志. |
| `stop [--graph <id or name> [--sync-server <url>] | --folder <path> | --all]` | 保存一个图表并结束其背景过程,或者每个图表都是没有命名的时候. |
| `logout [--sync-server <url> | --all]` | 撤销服务器的令牌,忘记它和加密密钥,停止其图形的背景过程并删除其缓存的图形. `--all` 用于每个服务器,并清除整个缓存、语义运行时间和模型. |
| `semantic setup` | 将嵌入运行时间和模型安装到缓存目录中 . |
| `semantic status` | 是否设置了语义搜索,每个缓存图的嵌入进度. |
| `semantic remove` | 删除运行时间和模式 。 所储存的嵌入物留在原地,如果再次设置,则重新使用. |
| `publish (--graph <id or name> | --folder <path>) --publication <id> [--out <dir> | --github <owner/name[#branch]> | --dry-run] [--replace]` | 将一个图表出版物发布到文件夹,或作为 GitHub 仓库的承诺,并打印报告. |
| `diagrams setup` | 在缓存目录中安装一个Chrimium,这样发布可以绘制美人鱼图,地图和图. |
| `diagrams status` | 发布会使用哪个浏览器, 如果有的话, 以及它是否从这个终端开始 。 以 1 退出, 浏览器不启动时出现错误 . |

### 旗帜

| 旗帜 | 适用于 | 含义 |
| --- | --- | --- |
| `--sync-server <url>` | `login`, (中文(简体) ), `graphs`, (中文(简体) ), `serve --graph`, (中文(简体) ), `publish --graph`, (中文(简体) ), `stop --graph`, (中文(简体) ), `logout` | 命令所指的同步服务器 。 所需经费 `login`,其他选项,但只有一个服务器被签名. `serve` 财务报告和审定财务报表 `logout` 拒绝在几个人之间猜测. |
| `--code <Agent Setup Code>` | `login` | 一次性代理设置代码. 它工作一次,在10分钟内. |
| `--pat <token>` | `login` | 一个全账户访问符而不是代理设置代码. `login` 换成代理代币并撤销. |
| `--recovery-code` | `login` | 解锁您的恢复代码而不是设备批准 。 按键 `r` 时 `login` 等待也一样. |
| `--graph <id or name>` | `serve`, (中文(简体) ), `publish`, (中文(简体) ), `stop` | 同步图. 不是用这个 `--folder`。 。 。 . |
| `--folder <path>` | `serve`, (中文(简体) ), `publish`, (中文(简体) ), `stop` | 本地图形文件夹 。 不是用这个 `--graph` 或者说 `--sync-server`。 。 。 . |
| `--no-semantic` | `serve` | 即使设置了语义搜索, 也只保留此代理文本 . |
| `--all` | `logout`, (中文(简体) ), `stop` | 每个服务器,或每个图表. |
| `--publication <id>` | `publish` | 图表的哪个出版. |
| `--out <dir>` | `publish` | 所出地处. 为图和出版所记. |
| `--github <owner/name[#branch]>` | `publish` | 将网站交给此仓库的分支 。 记取了 `--out`。 。 。 . |
| `--replace` | `publish` | 让第一个发布到一个寄存器中替换一个持有其它东西的分支上的文件. |
| `--dry-run` | `publish` | 整理并检查出版物,打印整份报告,不写作. |

### 环境变量

设置一个变量 `serve` 应在代理登记簿中查找 `env` 还有你的外壳, 因为代理开始 `serve` 与自己的环境.

| 变量 | 含义 |
| --- | --- |
| `ETHERPK_PAT` | 脚本的全账户访问符 `login`,交换代理代币并被撤销. |
| `ETHERPK_RECOVERY_CODE` | 脚本的回收代码 `login --recovery-code`。 。 。 . |
| `ETHERPK_MCP_SECRETS` | `file` 在登录文件中保留代理符和加密密钥,即使存在密钥链. |
| `ETHERPK_MCP_CONFIG` | 登录文件 。 默认 `~/.config/etherpk/mcp.json`,或低于 `XDG_CONFIG_HOME` 当它被设定. |
| `ETHERPK_MCP_CACHE_DIR` | 图形的缓存目录,语义运行时间和模型. 默认 `~/.cache/etherpk/mcp`,或低于 `XDG_CACHE_HOME` 当它被设定. |
| `ETHERPK_MCP_PUBLISH_CONFIG` | 记得每个出版物的文件夹或寄存器的文件. 默认 `publish.json` 在登录文件旁边. |
| `ETHERPK_GITHUB_TOKEN` | GitHub 符号 `publish --github` 承诺 从运行的 shell 读取 `publish`。 。 。 . |
| `ETHERPK_GITHUB_API_URL` | GitHub 企业服务器的 API (`https://<host>/api/v3`)取而代之为 gi. com's. (英语). |
| `ETHERPK_MCP_SEMANTIC_THREADS` | 嵌入模型的线程 。 默认为核心的四分之一,最多为4个. |
| `ETHERPK_MCP_HOST_IDLE_SECONDS` | 一个图的背景过程在它最后的代理人消失后会保持多久. 默认300. |
| `ETHERPK_CHROMIUM` | 这台计算机上的铬用于绘制图表、地图和图画,而不是一个 `diagrams setup` 安装. |
| `ETHERPK_MAP_STYLE_URL` | MapLibre 风格 已出版地图的图片被绘制 。 默认 EtherPK 的地图主机; 空绘图到平原背景 . |
| `PLAYWRIGHT_BROWSERS_PATH` | 何处 `diagrams setup` 安装 Chrimium 并有出版物查找。 默认 `browsers/` 在缓存目录中. |
| `ETHERPK_MCP_DEBUG_MEMORY` | `1` 记录过程的内存每10秒使用一次,并随每个进度行一起使用. |

## 电脑上留下的是什么

-   **代理签名和你的加密密钥.** 他们进入了系统键盘 `login` 能够 使用 macOS 密钥链,或 Linux 桌面的密钥环 `secret-tool` (单位:千美元) `libsecret-tools` 在Debian和Ubuntu上的软件包。 登录文件, `~/.config/etherpk/mcp.json`, (中文(简体) ), 然后只命名服务器。 否则他们在登录文件中,只能由您的用户读取, 就像一个登录浏览器的存储. `login` 说哪一个。 任何运行中的程序 并且永远不要让任何人读取,打印 或搜索 `~/.config/etherpk`。 。 。 .
-   **您服务的每个同步图的缓存**下页 `~/.cache/etherpk/mcp/`,所以重新启动抓取 只是改变了 它可以读取你的笔记。 Sync 伺服器保留真伪的来源, a 此软件包的新版本重建了一个无法读取的缓存 .
-   **对于文件夹**,其索引,并通过语义搜索,其嵌入,在 `local/<folder name>-<hash of its path>/` 在缓存目录中。 什么也没有写进 文件夹.
-   **除了每个图的缓存**, (中文(简体) ), `host.json` 当其背景进程运行时,以及 `host.log`, (中文(简体) ), 指定图形文档的名称,并随缓存被删除。 进程在套接字上监听 在目录中,只有用户才能打开(`$XDG_RUNTIME_DIR/etherpk-mcp`,或 `etherpk-mcp-<uid>` 内 ),或者在Windows上随机命名的管子上.

在 Windows 上,登录文件和缓存都在下面 `C:\Users\<you>\.config\etherpk\` 财务报告和审定财务报表 `C:\Users\<you>\.cache\etherpk\`。 。 。 .

为了切断代理,撤销其在Sync Server的代理代号 **访问令牌** 页 次. `logout` 撤销符号本身并删除该计算机上的密钥和缓存的图表 。 如果电脑 或者其登录文件可能已被复制, 也选择 **替换加密密钥并锁定其他 设备** 在 EtherPK 中, 因此保存的密钥不再打开您的账户 .

## 从源头构建

软件包的来源是 `apps/mcp` 中。 它汇编客户端的同步, 通过 a 加密和索引代码 `$lib` 化名,所以它从寄存器根而不是从 仅此文件夹 :

```sh
pnpm install --frozen-lockfile
pnpm --filter @appsoftwareltd/etherpk-mcp check   # type check
pnpm --filter @appsoftwareltd/etherpk-mcp test    # unit tests, no server needed
pnpm --filter @appsoftwareltd/etherpk-mcp build   # dist/main.js, run with node dist/main.js
```

寄存器的CI发布每个发行到npm,版本与客户端相同. 检查一下 登记册上有一个版本:

```sh
npx -y @appsoftwareltd/etherpk-mcp@<version> --version
```

## 文件和许可证

整个指南是 [用你笔记的人工智能](https://docs.etherpk.com/using-ai-agents-with-your-notes)。 。 。 . 每个版本中的变化都发生在 [更改日志](https://github.com/appsoftwareltd/etherpk-client/blob/main/CHANGELOG.md),覆盖 此软件包和 EtherPK 客户端,在一个版本下一起发布.

该软件包可在"弹性许可证2.0"下获得([自由主义](https://npmcn.com/package/%40appsoftwareltd/etherpk-mcp/LICENSE)你可以使用,复制, 修改和自行托管,但不作为托管或管理服务提供给他人。 没错 来源可用,不是开源.

## 常见问题

### @appsoftwareltd/etherpk-mcp 是什么？

EtherPK 无头客户端:一个通过同步知识图的MCP服务器,运行在用户自己机器上的代理机旁\.

### 如何安装 @appsoftwareltd/etherpk-mcp？

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

### @appsoftwareltd/etherpk-mcp 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/appsoftwareltd\_\_etherpk-mcp 是否存在。

### @appsoftwareltd/etherpk-mcp 支持 ESM 还是 CommonJS？

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

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

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

### @appsoftwareltd/etherpk-mcp 可以商用吗？

@appsoftwareltd/etherpk-mcp 使用 Elastic-2\.0 许可。声明的许可为 Elastic-2\.0，请阅读许可原文确认使用条件。以上为概括，不构成法律意见，请以许可原文为准。

### @appsoftwareltd/etherpk-mcp 的下载量有多少？

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

### @appsoftwareltd/etherpk-mcp 还在维护吗？

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