@hudsonkit/arc-mcp 0.0.0-stage → 0.13.2
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/LICENSE +21 -0
- package/README.md +108 -2
- package/dist/arc-mcp.mjs +37062 -0
- package/package.json +59 -4
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Arach Tchoupani
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,3 +1,109 @@
|
|
|
1
|
-
|
|
1
|
+
<div align="center">
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
<img src="https://raw.githubusercontent.com/hudsonkit/arc/main/public/arc-mark.svg" alt="Arc" width="52" height="52" />
|
|
4
|
+
|
|
5
|
+
# @hudsonkit/arc-mcp
|
|
6
|
+
|
|
7
|
+
### MCP server for architecture diagrams as code.
|
|
8
|
+
|
|
9
|
+
Gives AI agents the full Arc toolchain over the Model Context Protocol —
|
|
10
|
+
author, validate, lay out, render, and diff architecture diagrams from any
|
|
11
|
+
MCP client.
|
|
12
|
+
|
|
13
|
+
[](https://www.npmjs.com/package/@hudsonkit/arc-mcp)
|
|
14
|
+
[](https://github.com/hudsonkit/arc/blob/main/LICENSE)
|
|
15
|
+
|
|
16
|
+
</div>
|
|
17
|
+
|
|
18
|
+
## Run it
|
|
19
|
+
|
|
20
|
+
No install needed — the server runs over stdio:
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
npx -y @hudsonkit/arc-mcp
|
|
24
|
+
# or: bunx @hudsonkit/arc-mcp
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Client setup
|
|
28
|
+
|
|
29
|
+
**Claude Code:**
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
claude mcp add --scope project arc -- npx -y @hudsonkit/arc-mcp
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
**Devin:**
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
devin mcp add arc -- npx -y @hudsonkit/arc-mcp
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
**Any MCP client (JSON config):**
|
|
42
|
+
|
|
43
|
+
```json
|
|
44
|
+
{
|
|
45
|
+
"mcpServers": {
|
|
46
|
+
"arc": {
|
|
47
|
+
"command": "npx",
|
|
48
|
+
"args": ["-y", "@hudsonkit/arc-mcp"]
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
## Tools
|
|
55
|
+
|
|
56
|
+
| Tool | What it does |
|
|
57
|
+
|------|--------------|
|
|
58
|
+
| `validate_diagram` | Coded diagnostics for `ArcDiagramData` — consume by `code`, apply a `supportedFixes` entry, re-validate |
|
|
59
|
+
| `auto_layout` | Auto-layout a full diagram or minimal input (`nodeData` + `connectors` + `connectorStyles`) |
|
|
60
|
+
| `diff_diagram` | Structural `DiagramDelta` — feed to `<ArcDiagram data={head} delta={delta} />` for a diff render |
|
|
61
|
+
| `render_svg` | Deterministic SVG export — eleven themes, light/dark; authored flows animate via SMIL or sample at `flowTime` |
|
|
62
|
+
| `render_png` | PNG raster via a local Chrome/Chromium binary (`ARC_CHROME` to override, `ARC_CHROME=none` to disable), sampled at `flowTime` |
|
|
63
|
+
| `render_animation` | GIF/MP4 flow animation to an `output` path via Chrome frames + ffmpeg (`ARC_FFMPEG` to override) |
|
|
64
|
+
| `render_html` | React component snippet, iframe embed, or standalone HTML page |
|
|
65
|
+
| `render_ascii` | Unicode/ASCII box-art rendering for terminals and docs |
|
|
66
|
+
| `diagram_to_typescript` | Emit a typed `ArcDiagramData` TypeScript module |
|
|
67
|
+
| `editor_handoff` | Build URLs that open the diagram in the Arc studio |
|
|
68
|
+
|
|
69
|
+
## Resources
|
|
70
|
+
|
|
71
|
+
| URI | Content |
|
|
72
|
+
|-----|---------|
|
|
73
|
+
| `arc://schema/diagram` | Generated draft-07 JSON Schema for `ArcDiagramData` |
|
|
74
|
+
| `arc://skill/diagrams` | Arc diagram-generation skill for agents |
|
|
75
|
+
| `arc://docs/llm` | Dense LLM briefing |
|
|
76
|
+
|
|
77
|
+
## Self-hosting over HTTP
|
|
78
|
+
|
|
79
|
+
The published bin runs over stdio, which is all a local client needs. To serve
|
|
80
|
+
Arc to clients on other machines, run the Streamable HTTP server from a checkout
|
|
81
|
+
of the repo:
|
|
82
|
+
|
|
83
|
+
```bash
|
|
84
|
+
git clone https://github.com/hudsonkit/arc && cd arc
|
|
85
|
+
bun install
|
|
86
|
+
ARC_MCP_HOST=127.0.0.1 ARC_MCP_PORT=5190 bun run mcp:http
|
|
87
|
+
# MCP endpoint: http://127.0.0.1:5190/mcp · health: /health
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
| Variable | Default | Purpose |
|
|
91
|
+
|----------|---------|---------|
|
|
92
|
+
| `ARC_MCP_PORT` | `5190` | Port to listen on |
|
|
93
|
+
| `ARC_MCP_HOST` | `0.0.0.0` | Interface to bind; use `127.0.0.1` unless it sits behind your own auth |
|
|
94
|
+
| `ARC_EDITOR_URL` | `http://localhost:5188` | Studio base that `editor_handoff` links point to |
|
|
95
|
+
|
|
96
|
+
Arc doesn't run a public MCP endpoint. If you need a hosted one, open an issue
|
|
97
|
+
at [github.com/hudsonkit/arc](https://github.com/hudsonkit/arc/issues).
|
|
98
|
+
|
|
99
|
+
## Related packages
|
|
100
|
+
|
|
101
|
+
- [`@hudsonkit/arc`](https://www.npmjs.com/package/@hudsonkit/arc) — React renderer, visual studio, `arc` CLI, ASCII renderer
|
|
102
|
+
- [`@hudsonkit/arc-viewer`](https://www.npmjs.com/package/@hudsonkit/arc-viewer) — native Mermaid sequence diagrams + Mermaid import
|
|
103
|
+
- [`@hudsonkit/arc-iso`](https://www.npmjs.com/package/@hudsonkit/arc-iso) — isometric renderer for vanilla JS and the browser
|
|
104
|
+
|
|
105
|
+
Studio + docs: [arc.jdi.sh](https://arc.jdi.sh) · Source: [github.com/hudsonkit/arc](https://github.com/hudsonkit/arc)
|
|
106
|
+
|
|
107
|
+
## License
|
|
108
|
+
|
|
109
|
+
[MIT](https://github.com/hudsonkit/arc/blob/main/LICENSE)
|