# emerald-mcp 中文文档

规范地址：https://npmcn.com/package/emerald-mcp/

版本：0\.3\.0
npm 元数据更新时间：2026-11-03T13:56:03.876Z
中文译文更新时间：2026-11-03T14:12:58.872Z
软件包许可：AGPL-3\.0-only

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

原始 npm 页面：https://www.npmjs.com/package/emerald-mcp
原文对照：https://npmcn.com/package/emerald-mcp/?lang=original
项目主页：https://getemerald.dev/
源码仓库：https://github.com/kfireliyahu/emerald-emd

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

- 包体积（解压后）：10.5 MB，7 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=20\.19\.0
- 运行依赖：0 个
- 首次发布：2026-10-18T14:22:35.403Z
- 最新版本发布：2026-11-03T13:56:03.699Z
- 已发布版本数：9（近 12 个月 9 个）

## 中文简介

Emerald的MCP服务器：在a中声明格式。emd文件-磁盘上的一个真正的SQLite数据库-模型读取，写入和检查。Local-first：无账号，无网络呼叫。

## 安装

```sh
npm install emerald-mcp
```

也可以使用：`pnpm add emerald-mcp`、`yarn add emerald-mcp`、`bun add emerald-mcp`

## README

# emerald-mcp

的MCP服务器 [翡翠](https://getemerald.dev/)： **数据库下的聊天。** 一个 `.emd` 文件是磁盘上真正的SQLite数据库。将任何东西保持为您声明的表的行。 会议、笔记、项目决策、资金——你的助理会问你需要什么 而不是重新读取文件：键入字段过滤准确，链接遵循，每个会话看到 同样的行。写操作在着陆时进行检查。

```
claude mcp add emerald -- npx -y emerald-mcp --engine-only
```

任何启动stdio服务器的MCP客户端都以相同的方式运行它：命令 `npx`，论点 `["-y", "emerald-mcp", "--engine-only"]`。对账本上的工具也不要打旗子。每个工具都取绝对路径 `.emd` 它起作用了。在克劳德。 代码，插件带来了钩子和技能： `/plugin marketplace add kfireliyahu/emerald-emd`,然后 `/plugin install emerald@emerald-emd`。

## 一个模型在里面工作

-   你的助手直接读取和写入文件，在应用程序绘制MCP应用程序的地方，显示一个 聊天中的表、板或路线图。
-   每次编写都首先作为演练显示。在你说“提交”之前，什么都不会改变。
-   它读取你已经保存在表格上的数据：电子表格(`.csv`， `.xlsx`),一个 `.json` 的 行，或一个文件夹的Markdown笔记-一个笔记一行，其前页作为列，其 `[[links]]` 作为链接-阅读它在哪里，永远不会改变。
-   成型的工具，从来没有一个一般的查询：28的任何文件，85与分类帐。
-   文档按行回答，因此模型会询问它需要什么，而不是从头到尾读取注释 结束。
-   一个项目的会话在另一个项目的收件箱中留下一张纸条，下一个项目的会话就从它开始。

## 包

包是某人已经用他们的观点制定的格式，准备保存在文档中。两个 与翡翠同来；

-   **开发包**：一个项目的记忆作为行-里程碑，单位，决策，开放 问题，收件箱。会话从行开始，而不是从聊天摘要开始。
-   **在分类帐**个人财务，从你已经得到的文件-卡对账单，银行出口， 工资单，基金报告。每个总数打开到它被求和的行。没有任何东西与 你的银行。

## 不能上网，不能登录

-   服务器打开给它的文件，完成一个任务，然后关闭它，并且不对其进行网络调用 自己的。
-   文件是你的了。 `sqlite3` 普通工具也能读懂；把它倒在你喜欢的地方，拿去吧 任何地方。

## 运行它

-   `emerald-mcp --engine-only` 引擎的工具，适用于任何文件五分之一的定义 搬不动。
-   `emerald-mcp` -引擎的工具和分类账（个人理财包）。
-   `emerald-mcp watch <document.emd> [--format <name>]` -为每一行更改打印一行。
-   `emerald-mcp init [path/to/document.emd]` —在存储库中运行：使用 发展包(`docs/memory.emd` 除非命名;作为存储库中的文本，所以它不同)， 的标记部分 `CLAUDE.md` 一节课从提问开始 在没有安装Claude Code插件的地方，它的两个挂钩到 `.claude/settings.json`。第二次运行改变不了什么。

另外两个箱子是用于Claude Code的插件： `emerald-hooks` （它的钩子打印）和 `emerald-status-line`。他们是与 `npx -p emerald-mcp <bin>`。

授权agpl - 3.0; `THIRD_PARTY_NOTICES.txt` 携带捆绑产品的许可证。

## 常见问题

### emerald-mcp 是什么？

Emerald的MCP服务器：在a中声明格式。emd文件-磁盘上的一个真正的SQLite数据库-模型读取，写入和检查。Local-first：无账号，无网络呼叫。

### 如何安装 emerald-mcp？

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

### emerald-mcp 支持 TypeScript 吗？

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

### emerald-mcp 支持 ESM 还是 CommonJS？

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

### emerald-mcp 需要什么版本的 Node\.js？

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

### emerald-mcp 可以商用吗？

emerald-mcp 使用 AGPL-3\.0-only 许可。最严格的 Copyleft：除分发外，通过网络向用户提供基于它的服务也需要开源对应源码。闭源 SaaS 使用前务必评估。以上为概括，不构成法律意见，请以许可原文为准。

### emerald-mcp 还在维护吗？

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