emerald-mcp

中文文档
0.3.0发布于 2026/11/03AGPL-3.0-onlyES Module零依赖

Emerald's MCP server: declared formats in a .emd file — a real SQLite database on your disk — that a model reads, writes and checks. Local-first: no account, no network call.

原始使用文档
文档目录4 节
  1. A model works in it
  2. Packs
  3. No internet, no login
  4. Running it

emerald-mcp

The MCP server of Emerald: the database under the chat. A .emd file is a real SQLite database on your disk. Keep anything as rows of a table you declare — tasks, meetings, notes, a project's decisions, money — and your assistant asks for the rows it needs instead of re-reading files: typed fields filter exactly, links are followed, and every session sees the same rows. Writes are checked as they land.

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

Any MCP client that starts a stdio server runs it the same way: the command npx, the arguments ["-y", "emerald-mcp", "--engine-only"]. Leave the flag off for the ledger's tools too. Every tool takes the absolute path of the .emd it works on. In Claude Code, the plugin brings it with its hooks and a skill: /plugin marketplace add kfireliyahu/emerald-emd, then /plugin install emerald@emerald-emd.

A model works in it

  • Your assistant reads and writes the file directly, and where the app draws MCP Apps, shows a table, board or roadmap in the chat.
  • Every write is shown first as a dry run. Nothing changes until you say commit.
  • It reads what you already keep onto your tables: a spreadsheet (.csv, .xlsx), a .json of rows, or a folder of Markdown notes — a note a row, its frontmatter as columns, its [[links]] as links — read where it is and never changed.
  • Shaped tools, never a general query: 28 for any document, 85 with the ledger.
  • A document answers in rows, so the model asks for what it needs instead of reading notes end to end.
  • One project's session leaves a note in another's inbox, and the next session there starts with it.

Packs

A pack is formats somebody already worked out, with their views, ready to keep in a document. Two come with Emerald:

  • The development pack: a project's memory as rows — milestones, units, decisions, open questions, an inbox. A session starts from the rows, not from a summary of a chat.
  • The ledger: personal finance from the files you already get — card statements, bank exports, payslips, fund reports. Every total opens to the rows it was summed from. Nothing connects to your bank.

No internet, no login

  • The server opens the file it is given, does one job, closes it, and makes no network call of its own.
  • The file is yours: sqlite3 and ordinary tools read it; back it up where you like, take it anywhere.

Running it

  • emerald-mcp --engine-only — the engine's tools, for any document; a fifth of the definitions to carry.
  • emerald-mcp — the engine's tools and the ledger's (a personal-finance pack).
  • emerald-mcp watch <document.emd> [--format <name>] — prints a line for each row that changes.
  • emerald-mcp init [path/to/document.emd] — run in a repository: creates its document with the development pack (docs/memory.emd unless named; as text inside the repository, so it diffs), writes a marked section of CLAUDE.md with the questions a session starts from and every format's columns, and, where the Claude Code plugin is not installed, its two hooks into .claude/settings.json. A second run changes nothing.

Two more bins are for Claude Code's plugin: emerald-hooks (what its hooks print) and emerald-status-line. They are reached with npx -p emerald-mcp <bin>.

Licensed AGPL-3.0-only; THIRD_PARTY_NOTICES.txt carries the licences of what is bundled.

版本与发布记录

emerald-mcp 共发布 9 个版本,首次发布于 2026/10/18;过去 12 个月发布了 9 个版本。

版本发布日期距今
0.3.0latest2026/11/03今天
0.2.02026/10/2311 天前
0.1.62026/10/2014 天前
0.1.52026/10/1915 天前
0.1.42026/10/1915 天前
0.1.22026/10/1916 天前

关于 emerald-mcp 的常见问题

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 和提交记录判断。