@buun_group/plotwork-mcp

中文文档
0.12.0发布于 2026/10/30MITES Module零依赖构建来源已验证近 30 天下载 7361

No API key and no account. Plotwork MCP server for local use over stdio: read-only tools that draw, validate, outline, convert, and render twenty-nine kinds of diagram, from flow, sequence, and database to Gantt, state, mind map, and treemap. It sends not

原始使用文档
文档目录14 节
  1. TL;DR
  2. Install
  3. Claude Code
  4. Cursor
  5. VS Code
  6. Claude Desktop
  7. Other clients
  8. Open and self-hosted models
  9. Check it by hand
  10. Usage counts (off unless you turn them on)
  11. The hosted server
  12. License
  13. About this repository
  14. See also

Plotwork

Plotwork MCP server

The Plotwork diagram tools as a local MCP (Model Context Protocol) server. An AI agent uses it to read the diagram language, validate source, check an outline, and render twenty-nine kinds of diagram, from flow, sequence, and database to Gantt, state, mind map, and treemap as SVG. It runs on your machine over standard input and output.

TL;DR

QuestionAnswer
Does it need an API key?No. There is no key, no sign-in, and no account.
Does it use the network?Not by default. Every tool is a pure computation over its arguments, and with nothing set it reads no file but its own (the program, and the icon art in icons/ beside it) and your repository's settings (plotwork.config.json, if you have one), writes none, and makes no network request. Only if you set PLOTWORK_USAGE does it count your tool calls, and only if you set it to share does it send anything. See Usage counts.
How do I start it?npx -y @buun_group/plotwork-mcp. Your MCP client runs this command for you.
Which Node version?Node 22 or newer.
What are the tools?Workflows that draw a diagram, convert Mermaid, choose icons, and sync a Markdown document in one call, and single steps for fine control. All are read-only. Your client lists them, and the tool reference in the documentation has every name and schema.
Is there a hosted version?Yes, at https://mcp.plotwork.dev. It needs an API key or a browser sign-in. See the hosted server.
Which licence?MIT. Code and data from other people keep their own licences, listed in THIRD-PARTY-NOTICES.md. See License.

Install

Nothing is installed globally. Your client starts the server with npx, and npx downloads this package on first use.

Claude Code

claude mcp add plotwork -- npx -y @buun_group/plotwork-mcp

Then run /mcp in Claude Code and check that plotwork is connected and lists the Plotwork tools.

Cursor

Add this to ~/.cursor/mcp.json:

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

VS Code

Add this to .vscode/mcp.json:

{
  "servers": {
    "plotwork": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "@buun_group/plotwork-mcp"]
    }
  }
}

Claude Desktop

Add this to claude_desktop_config.json, then restart Claude Desktop:

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

Other clients

Any client that starts an MCP server as a local process takes the same two parts: the command npx and the arguments -y @buun_group/plotwork-mcp.

Open and self-hosted models

A model with a small context (an open model on Ollama, LM Studio, vLLM, or llama.cpp) does better with fewer tools. Add --tools core to the arguments, or set PLOTWORK_TOOLS=core, and the server lists only its eight workflow tools with short descriptions: about 1,700 tokens instead of about 17,500. The tools answer the same. See Use Plotwork with open and self-hosted models.

Check it by hand

npx -y @buun_group/plotwork-mcp --version
npx -y @buun_group/plotwork-mcp --help

Run with no arguments, plotwork-mcp waits for an MCP client on standard input. Standard output carries only protocol messages. One log line per tool call goes to standard error, with the tool, the outcome, the duration, and the size of the arguments. The contents of the arguments are never logged.

Usage counts (off unless you turn them on)

By default the package counts nothing and keeps no file. You can ask it to count how often each tool is used on your own machine, and, separately, to send pseudonymous daily totals to Plotwork so the project can see which tools matter. Both are off until you set PLOTWORK_USAGE in the env block of your client or in your shell. There is no config file, so nothing is switched on out of sight.

SettingWhat it does
PLOTWORK_USAGE unset, empty, or any other valueOff. Nothing is counted, saved, or sent.
PLOTWORK_USAGE=localCounts calls on this device, in one file, usage.json. Nothing is sent.
PLOTWORK_USAGE=shareCounts the same way, and once a day sends the totals of each finished day.
DO_NOT_TRACK=1 (or true)Caps the setting at local, so nothing is ever sent, whatever else is set.
PLOTWORK_HOMEThe folder for usage.json. The default is .plotwork in your home folder.

Only counts are kept. A count is a tool name, the diagram kind the source declared (flow, sequence, schema, or none), how the call ended (ok, rejected, or error), and a number, for each UTC day. Diagram source, arguments, names, file paths, error messages, your host name and user name, and the time of day are never counted or sent.

What share sends is a small JSON body with those counts, a pseudonym for the month (a keyed hash that changes every month, so Plotwork can count active installs in a month but cannot follow one from month to month), the package version, your operating system family, and the Node major version. It carries no cookie, no account, and no key. It never sends today, never follows a redirect, gives up after three seconds, and fails silently.

You can look at all of it before you decide:

npx -y @buun_group/plotwork-mcp usage            # the setting, the counts of the last 30 days, and the next send
npx -y @buun_group/plotwork-mcp usage preview    # the exact request a send would post, or "nothing to send"
npx -y @buun_group/plotwork-mcp usage reset      # delete the file, with its secret and every count

These commands never touch the network.

The hosted server

The hosted server runs the same tools at https://mcp.plotwork.dev. Use it when a client cannot start a local process, or when you want one shared endpoint. It is not part of this package, and it asks for a credential.

Way inAddressCredential
API keyhttps://mcp.plotwork.dev/mcpCreate a key at app.plotwork.dev and send it in the X-API-Key header.
Browser sign-in (OAuth)https://mcp.plotwork.dev/mcp-oauthNone to copy. Your client opens a browser and you sign in.

The documentation has the exact settings for each client.

License

@buun_group/plotwork-mcp is licensed under the MIT licence. The text is in the file LICENSE.

The single file plotwork-mcp.mjs also contains code and data that other people wrote: the MCP SDK, the zod validation library, the ELK layout engine, icon artwork, and font measurements. Each keeps its own licence. THIRD-PARTY-NOTICES.md lists every one with its version, copyright, and the full licence text. The MIT licence of this package does not replace those licences.

The package includes the official architecture icons of AWS, Microsoft Azure, Google Cloud, unmodified. They belong to their owners and are not covered by the MIT licence. Their terms and the trademark notice are in THIRD-PARTY-NOTICES.md.

About this repository

This repository holds the built package that is published to npm, updated by an automated release. A change here is replaced by the next release, so open an issue instead of a pull request. Releases are immutable: a published version is never changed, and a fix is a new version.

Each release carries checksums.txt with the SHA-256 of every file in the package, including LICENSE and THIRD-PARTY-NOTICES.md. To check a download:

sha256sum --check checksums.txt

See also

LinkWhy
DocumentationThe diagram language, the tool reference, and client settings
IssuesReport a problem or ask a question
Security policyReport a vulnerability privately

版本与发布记录

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

版本发布日期距今
0.12.0latest2026/10/309 天前
0.12.0-beta.1beta2026/10/2910 天前
0.11.0-beta.22026/10/2910 天前
0.11.0-beta.12026/10/2910 天前
0.10.02026/10/2811 天前
0.10.0-beta.12026/10/2811 天前

其他发布通道:reserved → 0.0.0,beta → 0.12.0-beta.1。

关于 @buun_group/plotwork-mcp 的常见问题

@buun_group/plotwork-mcp 是什么?

No API key and no account. Plotwork MCP server for local use over stdio: read-only tools that draw, validate, outline, convert, and render twenty-nine kinds of diagram, from flow, sequence, and database to Gantt, state, mind map, and treemap. It sends not

如何安装 @buun_group/plotwork-mcp?

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

@buun_group/plotwork-mcp 支持 TypeScript 吗?

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

@buun_group/plotwork-mcp 支持 ESM 还是 CommonJS?

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

@buun_group/plotwork-mcp 需要什么版本的 Node.js?

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

@buun_group/plotwork-mcp 可以商用吗?

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

@buun_group/plotwork-mcp 的下载量有多少?

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

@buun_group/plotwork-mcp 还在维护吗?

最新版本 0.12.0 发布于 2026/10/30(9 天前);至今共发布 48 个版本,其中过去 12 个月发布了 48 个;首次发布于 2026/10/10。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。