@slickfast/mcp 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/LICENSE +661 -0
- package/README.md +49 -0
- package/dist/index.js +1360 -0
- package/package.json +21 -0
package/README.md
ADDED
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# SlickFast MCP server
|
|
2
|
+
|
|
3
|
+
Exposes the render-core engine as an MCP tool so an AI agent can generate charts.
|
|
4
|
+
|
|
5
|
+
- **Tool:** `render_chart(spec)` → returns the chart as an SVG string. Spec contract
|
|
6
|
+
is in `../../packages/render-core/SPEC.md` (also served as the `chart-spec` resource).
|
|
7
|
+
- **Transport:** stdio (local). Streamable HTTP (remote/hosted, e.g. Railway) comes later.
|
|
8
|
+
|
|
9
|
+
## Run / test
|
|
10
|
+
```bash
|
|
11
|
+
npm install
|
|
12
|
+
node test-client.mjs # spawns the server, calls render_chart, checks the SVG
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Use it in Claude Desktop
|
|
16
|
+
Add to `claude_desktop_config.json` (Settings → Developer → Edit Config):
|
|
17
|
+
```json
|
|
18
|
+
{
|
|
19
|
+
"mcpServers": {
|
|
20
|
+
"slickfast": {
|
|
21
|
+
"command": "node",
|
|
22
|
+
"args": ["/Users/alexmacbook/SlickFast/platform/apps/mcp/server.mjs"]
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
```
|
|
27
|
+
Restart Claude Desktop, then ask it to "render a bar chart of …" — it calls `render_chart`.
|
|
28
|
+
|
|
29
|
+
## Use it in Claude Code
|
|
30
|
+
Project-scoped config (`.mcp.json` at the workspace root):
|
|
31
|
+
```json
|
|
32
|
+
{ "mcpServers": { "slickfast": { "command": "node", "args": ["/Users/alexmacbook/SlickFast/platform/apps/mcp/server.mjs"] } } }
|
|
33
|
+
```
|
|
34
|
+
Restart the session; the `render_chart` tool becomes available.
|
|
35
|
+
|
|
36
|
+
Note: stdio returns SVG text. For charts to appear *inline* in a chat surface
|
|
37
|
+
(Discord/Slack/Desktop), the tool needs to return PNG — that's the raster step (paid path), added later.
|
|
38
|
+
|
|
39
|
+
## Install via npm (published)
|
|
40
|
+
```json
|
|
41
|
+
{ "mcpServers": { "slickfast": { "command": "npx", "args": ["-y", "@slickfast/mcp"] } } }
|
|
42
|
+
```
|
|
43
|
+
Restart Claude; everything runs locally on your machine — nothing leaves.
|
|
44
|
+
|
|
45
|
+
## License
|
|
46
|
+
**AGPL-3.0-only.** Free to use, self-host, and embed under the AGPL's terms (your friends
|
|
47
|
+
running it locally are completely unaffected). Building it into a **closed-source product
|
|
48
|
+
or a hosted service**? That needs the AGPL'd source opened — or a **commercial license**
|
|
49
|
+
from us instead. Reach out for commercial terms.
|