@svgrid/mcp 1.0.0 → 2.0.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 +2 -2
- package/README.md +51 -31
- package/dist/data.js +1945 -125
- package/dist/index.js +4 -4
- package/package.json +41 -40
package/LICENSE
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
SV-GRID-MCP COMMERCIAL LICENSE
|
|
2
2
|
Version 1.0
|
|
3
3
|
|
|
4
|
-
Copyright (c) 2026
|
|
4
|
+
Copyright (c) 2026 jQWidgets Ltd
|
|
5
5
|
Project: @svgrid/mcp
|
|
6
6
|
|
|
7
7
|
This software is licensed, not sold. Use requires a valid, paid SvGrid
|
|
@@ -77,6 +77,6 @@ preceding the event giving rise to the claim.
|
|
|
77
77
|
|
|
78
78
|
To purchase a license, request a quote, or report unauthorized use,
|
|
79
79
|
contact: boikom@jqwidgets.com
|
|
80
|
-
Pricing: https://
|
|
80
|
+
Pricing: https://svgrid.com/pricing
|
|
81
81
|
|
|
82
82
|
END OF LICENSE
|
package/README.md
CHANGED
|
@@ -1,44 +1,54 @@
|
|
|
1
|
-
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img src="https://svgrid.com/brand/svgrid-logo-icon-1200.png" alt="SvGrid" width="100" height="100" />
|
|
3
|
+
</p>
|
|
2
4
|
|
|
3
|
-
|
|
4
|
-
Point an MCP-capable client (Claude Desktop, Claude Code, Cursor, etc.) at
|
|
5
|
-
this server and the model gets accurate, version-pinned answers about
|
|
6
|
-
SvGrid - no hallucinated APIs, no stale blog posts.
|
|
5
|
+
<h1 align="center">@svgrid/mcp</h1>
|
|
7
6
|
|
|
8
|
-
|
|
7
|
+
<p align="center"><strong>The official Model Context Protocol server for SvGrid.</strong></p>
|
|
8
|
+
|
|
9
|
+
<p align="center">
|
|
10
|
+
<a href="https://www.npmjs.com/package/@svgrid/mcp"><img src="https://img.shields.io/npm/v/%40svgrid%2Fmcp.svg?label=%40svgrid%2Fmcp" alt="npm version" /></a>
|
|
11
|
+
<a href="https://svgrid.com">Website</a> ·
|
|
12
|
+
<a href="https://svgrid.com/docs">Docs</a>
|
|
13
|
+
</p>
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
Point any MCP-capable client - Claude Desktop, Claude Code, Cursor, Zed - at this server and the model answers with **accurate, version-pinned** facts about SvGrid: real prop, method, and event names, plus every demo's source as grounding. No hallucinated APIs, no stale blog posts.
|
|
18
|
+
|
|
19
|
+
## Tools exposed
|
|
9
20
|
|
|
10
21
|
| Tool | Purpose |
|
|
11
22
|
| --- | --- |
|
|
12
|
-
| `list_examples` |
|
|
23
|
+
| `list_examples` | Every demo: id, title, and one-line blurb. |
|
|
13
24
|
| `get_example_source` | Full `.svelte` source for a demo by id. |
|
|
14
|
-
| `list_docs` | Every
|
|
25
|
+
| `list_docs` | Every documentation page (slug + title). |
|
|
15
26
|
| `get_doc` | Markdown for a single doc by slug. |
|
|
16
|
-
| `search_docs` | Case-insensitive substring search across docs. |
|
|
17
|
-
| `get_api_reference` |
|
|
27
|
+
| `search_docs` | Case-insensitive substring search across the docs. |
|
|
28
|
+
| `get_api_reference` | The curated public-API surface, grouped by category. |
|
|
18
29
|
|
|
19
|
-
##
|
|
30
|
+
## Run
|
|
20
31
|
|
|
21
32
|
```bash
|
|
22
33
|
# One-shot via npx (no install)
|
|
23
34
|
npx @svgrid/mcp
|
|
24
35
|
|
|
25
|
-
# Or install
|
|
36
|
+
# Or install globally, then run the bin
|
|
26
37
|
npm install -g @svgrid/mcp
|
|
27
38
|
@svgrid/mcp
|
|
28
39
|
```
|
|
29
40
|
|
|
30
|
-
The server speaks MCP over **stdio
|
|
31
|
-
go to stderr.
|
|
41
|
+
The server speaks MCP over **stdio**: stdout is reserved for JSON-RPC, logs go to stderr.
|
|
32
42
|
|
|
33
|
-
##
|
|
43
|
+
## Connect Claude Desktop
|
|
34
44
|
|
|
35
|
-
Edit `~/Library/Application Support/Claude/claude_desktop_config.json`
|
|
36
|
-
|
|
45
|
+
Edit `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS) or
|
|
46
|
+
`%APPDATA%\Claude\claude_desktop_config.json` (Windows):
|
|
37
47
|
|
|
38
48
|
```json
|
|
39
49
|
{
|
|
40
50
|
"mcpServers": {
|
|
41
|
-
"
|
|
51
|
+
"svgrid": {
|
|
42
52
|
"command": "npx",
|
|
43
53
|
"args": ["-y", "@svgrid/mcp"]
|
|
44
54
|
}
|
|
@@ -46,21 +56,29 @@ Edit `~/Library/Application Support/Claude/claude_desktop_config.json`
|
|
|
46
56
|
}
|
|
47
57
|
```
|
|
48
58
|
|
|
49
|
-
Restart Claude Desktop
|
|
59
|
+
Restart Claude Desktop and open a new chat - the tools above are now available.
|
|
50
60
|
|
|
51
|
-
##
|
|
61
|
+
## Connect Claude Code
|
|
52
62
|
|
|
53
63
|
```bash
|
|
54
|
-
claude mcp add
|
|
64
|
+
claude mcp add svgrid -- npx -y @svgrid/mcp
|
|
55
65
|
```
|
|
56
66
|
|
|
57
|
-
Then in a session
|
|
67
|
+
Then run `/mcp` in a session to confirm `svgrid` is listed. Ask something like
|
|
68
|
+
*"using svgrid, build a grid that groups by department and shows a sparkline per row"*
|
|
69
|
+
and the model will pull the relevant demo sources before generating code.
|
|
70
|
+
|
|
71
|
+
## Connect Cursor / Zed
|
|
58
72
|
|
|
59
|
-
|
|
73
|
+
Add the same `mcpServers` block to the editor's MCP configuration:
|
|
60
74
|
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
75
|
+
```json
|
|
76
|
+
{
|
|
77
|
+
"mcpServers": {
|
|
78
|
+
"svgrid": { "command": "npx", "args": ["-y", "@svgrid/mcp"] }
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
```
|
|
64
82
|
|
|
65
83
|
## Build from source
|
|
66
84
|
|
|
@@ -71,10 +89,12 @@ node dist/index.js
|
|
|
71
89
|
```
|
|
72
90
|
|
|
73
91
|
`pnpm build` first runs `scripts/build-manifests.mjs`, which reads
|
|
74
|
-
`examples/src/demos/*.svelte` and `docs/**/*.md` from the workspace and
|
|
75
|
-
|
|
76
|
-
|
|
92
|
+
`examples/src/demos/*.svelte` and `docs/**/*.md` from the workspace and inlines
|
|
93
|
+
them into `src/data.ts`, so the published package is fully self-contained.
|
|
94
|
+
|
|
95
|
+
## Licensing
|
|
77
96
|
|
|
78
|
-
|
|
97
|
+
Commercial. Part of the SvGrid Enterprise offering; see [svgrid.com/pricing](https://svgrid.com/pricing).
|
|
98
|
+
The MIT [`@svgrid/grid`](https://www.npmjs.com/package/@svgrid/grid) core is free for any use.
|
|
79
99
|
|
|
80
|
-
|
|
100
|
+
SvGrid™ and sv-grid™ are trademarks of jQWidgets Ltd.
|