@svgrid/mcp 1.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 ADDED
@@ -0,0 +1,82 @@
1
+ SV-GRID-MCP COMMERCIAL LICENSE
2
+ Version 1.0
3
+
4
+ Copyright (c) 2026 Boyko Markov <boikom@jqwidgets.com>
5
+ Project: @svgrid/mcp
6
+
7
+ This software is licensed, not sold. Use requires a valid, paid SvGrid
8
+ Pro or Enterprise license. The MCP server bundles SvGrid example
9
+ sources, documentation, and API reference material; redistribution of
10
+ those materials outside this package is not permitted.
11
+
12
+ ------------------------------------------------------------------------
13
+ 1. GRANT (with valid SvGrid Pro or Enterprise license)
14
+ ------------------------------------------------------------------------
15
+
16
+ Subject to the Subscriber's compliance with this License and continued
17
+ payment of the applicable license fee, the Author grants the Subscriber
18
+ a non-exclusive, non-transferable, non-sublicensable license to:
19
+
20
+ (a) install and run the Software on developer workstations and on
21
+ build / CI machines belonging to the Subscriber;
22
+ (b) configure the Software as an MCP server for AI assistants used
23
+ by the Subscriber's developers;
24
+ (c) modify the Software for the Subscriber's internal use, provided
25
+ that all copyright notices and license terms are preserved.
26
+
27
+ The number of developer seats covered is determined by the
28
+ Subscriber's SvGrid Pro / Enterprise order. A "developer" is any
29
+ individual who uses an AI assistant configured against this MCP
30
+ server while writing or modifying source code that imports
31
+ `@svgrid/grid` or `@svgrid/enterprise`.
32
+
33
+ ------------------------------------------------------------------------
34
+ 2. RESTRICTIONS
35
+ ------------------------------------------------------------------------
36
+
37
+ The Subscriber may NOT:
38
+
39
+ (a) redistribute the Software as a standalone package, library, or
40
+ MCP server;
41
+ (b) sublicense, rent, lease, or sell the Software to third parties;
42
+ (c) extract the bundled SvGrid example sources, documentation, or
43
+ API reference material for use outside this package;
44
+ (d) use the Software to train, fine-tune, or evaluate a third-party
45
+ model intended for resale or public distribution;
46
+ (e) use the Software to develop a directly competing data-grid or
47
+ table component product.
48
+
49
+ ------------------------------------------------------------------------
50
+ 3. SUBSCRIPTION AND TERMINATION
51
+ ------------------------------------------------------------------------
52
+
53
+ The license is granted for the term specified in the Subscriber's
54
+ SvGrid Pro or Enterprise order. On non-renewal or material breach of
55
+ Sections 1 or 2, the license terminates automatically and the
56
+ Subscriber must cease all use of the Software and remove it from
57
+ development environments and CI infrastructure.
58
+
59
+ ------------------------------------------------------------------------
60
+ 4. WARRANTY DISCLAIMER AND LIABILITY
61
+ ------------------------------------------------------------------------
62
+
63
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
64
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
65
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND
66
+ NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
67
+ CLAIM, DAMAGES, OR OTHER LIABILITY ARISING FROM USE OF THE SOFTWARE,
68
+ WHETHER IN AN ACTION OF CONTRACT, TORT, OR OTHERWISE.
69
+
70
+ The Author's total cumulative liability under this License shall not
71
+ exceed the license fees paid by the Subscriber in the twelve months
72
+ preceding the event giving rise to the claim.
73
+
74
+ ------------------------------------------------------------------------
75
+ 5. CONTACT
76
+ ------------------------------------------------------------------------
77
+
78
+ To purchase a license, request a quote, or report unauthorized use,
79
+ contact: boikom@jqwidgets.com
80
+ Pricing: https://sv-grid.dev/pricing
81
+
82
+ END OF LICENSE
package/README.md ADDED
@@ -0,0 +1,80 @@
1
+ # @svgrid/mcp
2
+
3
+ A Model Context Protocol (MCP) server for [SvGrid](https://sv-grid.github.io/sv-grid/).
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.
7
+
8
+ ## What it exposes
9
+
10
+ | Tool | Purpose |
11
+ | --- | --- |
12
+ | `list_examples` | All 20 demo ids, titles, blurbs. |
13
+ | `get_example_source` | Full `.svelte` source for a demo by id. |
14
+ | `list_docs` | Every doc page (slug + title). |
15
+ | `get_doc` | Markdown for a single doc by slug. |
16
+ | `search_docs` | Case-insensitive substring search across docs. |
17
+ | `get_api_reference` | Curated public-API surface, grouped by category. |
18
+
19
+ ## Install + run
20
+
21
+ ```bash
22
+ # One-shot via npx (no install)
23
+ npx @svgrid/mcp
24
+
25
+ # Or install + run
26
+ npm install -g @svgrid/mcp
27
+ @svgrid/mcp
28
+ ```
29
+
30
+ The server speaks MCP over **stdio**. Stdout is reserved for JSON-RPC; logs
31
+ go to stderr.
32
+
33
+ ## Hook it into Claude Desktop
34
+
35
+ Edit `~/Library/Application Support/Claude/claude_desktop_config.json`
36
+ (macOS) or `%APPDATA%\Claude\claude_desktop_config.json` (Windows):
37
+
38
+ ```json
39
+ {
40
+ "mcpServers": {
41
+ "sv-grid": {
42
+ "command": "npx",
43
+ "args": ["-y", "@svgrid/mcp"]
44
+ }
45
+ }
46
+ }
47
+ ```
48
+
49
+ Restart Claude Desktop. Open a new chat - the tools above are now available.
50
+
51
+ ## Hook it into Claude Code
52
+
53
+ ```bash
54
+ claude mcp add sv-grid -- npx -y @svgrid/mcp
55
+ ```
56
+
57
+ Then in a session:
58
+
59
+ > /mcp
60
+
61
+ …and you'll see `sv-grid` listed. Ask Claude something like *"using sv-grid,
62
+ build me a grid that groups by department and shows a sparkline in each
63
+ row"* and it will pull the relevant example sources before generating code.
64
+
65
+ ## Build from source
66
+
67
+ ```bash
68
+ cd packages/mcp
69
+ pnpm build
70
+ node dist/index.js
71
+ ```
72
+
73
+ `pnpm build` first runs `scripts/build-manifests.mjs`, which reads
74
+ `examples/src/demos/*.svelte` and `docs/**/*.md` from the workspace and
75
+ inlines them into `src/data.ts` so the published npm package is
76
+ self-contained.
77
+
78
+ ## License
79
+
80
+ MIT. @svgrid/grid is also MIT-licensed; @svgrid/enterprise is a paid companion package under a separate commercial license.