@buun_group/plotwork-mcp 0.1.0-beta.8 → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -7,7 +7,7 @@ The Plotwork diagram tools as a local MCP (Model Context Protocol) server. An AI
7
7
  | Question | Answer |
8
8
  |---|---|
9
9
  | Does it need an API key? | No. There is no key, no sign-in, and no account. |
10
- | 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 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](#usage-counts-off-unless-you-turn-them-on). |
10
+ | 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](#usage-counts-off-unless-you-turn-them-on). |
11
11
  | How do I start it? | `npx -y @buun_group/plotwork-mcp`. Your MCP client runs this command for you. |
12
12
  | Which Node version? | Node 22 or newer. |
13
13
  | 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. |
@@ -76,6 +76,10 @@ Add this to `claude_desktop_config.json`, then restart Claude Desktop:
76
76
 
77
77
  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`.
78
78
 
79
+ ### Open and self-hosted models
80
+
81
+ 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](https://docs.plotwork.dev/mcp/open-models).
82
+
79
83
  ## Check it by hand
80
84
 
81
85
  ```sh
@@ -1,6 +1,6 @@
1
1
  # Third-party notices
2
2
 
3
- @buun_group/plotwork-mcp 0.1.0-beta.8 is licensed under the MIT licence, in the file LICENSE. The single file plotwork-mcp.mjs also contains code and data from other people. This file lists them, with the licence each is used under and the full licence text. Those licences apply to that material. The MIT licence of @buun_group/plotwork-mcp does not replace them, and it does not cover the vendor artwork described under "Trademarks and official icons".
3
+ @buun_group/plotwork-mcp 0.1.0 is licensed under the MIT licence, in the file LICENSE. The single file plotwork-mcp.mjs also contains code and data from other people. This file lists them, with the licence each is used under and the full licence text. Those licences apply to that material. The MIT licence of @buun_group/plotwork-mcp does not replace them, and it does not cover the vendor artwork described under "Trademarks and official icons".
4
4
 
5
5
  The build writes this file from the contents of the bundle. Do not edit it.
6
6
 
@@ -97,7 +97,7 @@ The build writes this file from the contents of the bundle. Do not edit it.
97
97
  - Licence declared: CC0-1.0
98
98
  - Used under: CC0-1.0
99
99
  - Repository: https://github.com/simple-icons/simple-icons
100
- - What is in the bundle: The path data of each brand mark, copied by gen:icons into a generated module and drawn as inline SVG.
100
+ - What is in the bundle: The path data of each brand mark, copied by gen:icons into a generated module and drawn as inline SVG. gen:icon-art splits it into the catalog the bundle holds, with the paths of the marks most diagrams draw, and the shards in icons/simple/ beside the bundle, which hold every path.
101
101
  - Copyright: No copyright line in the licence file. The package names Simple Icons Collaborators as its author.
102
102
  - NOTICE file: none shipped
103
103
  - Licence text: [text 6](#licence-text-6)
@@ -109,7 +109,7 @@ The build writes this file from the contents of the bundle. Do not edit it.
109
109
  - Licence declared: CC0-1.0
110
110
  - Used under: CC0-1.0
111
111
  - Repository: https://github.com/gilbarbara/logos
112
- - What is in the bundle: The full colour file of each of a few brand marks that Simple Icons does not publish, copied by gen:icons into a generated module as the text of a standalone SVG and drawn unmodified, as an image, on a light tile.
112
+ - What is in the bundle: The full colour file of each of a few brand marks that Simple Icons does not publish, copied by gen:icons into a generated module as the text of a standalone SVG and drawn unmodified, as an image, on a light tile. gen:icon-art keeps the files most diagrams draw in the bundle and every file in the shards in icons/simple/ beside it.
113
113
  - Copyright: No copyright line in the licence file.
114
114
  - Licence file: the package ships none, so the licence text its authors publish is used, from https://raw.githubusercontent.com/gilbarbara/logos/master/LICENSE.txt
115
115
  - NOTICE file: none shipped