@svgrid/mcp 2.6.4 → 2.6.6

package/README.md

@@ -28,15 +28,61 @@ Point any MCP-capable client - Claude Desktop, Claude Code, Cursor, Zed - at thi
 
 | Tool | Purpose |
 | --- | --- |
+| `check_svgrid_code` | **Verify** a file against the real API surface + the Svelte compiler. |
 | `list_examples` | Every demo: id, title, and one-line blurb. |
 | `get_example_source` | Full `.svelte` source for a demo by id. |
 | `list_docs` | Every documentation page (slug + title). |
 | `get_doc` | Markdown for a single doc by slug. |
-| `search_docs` | Case-insensitive substring search across the docs. |
+| `search_docs` | Ranked full-text search across the docs. |
 | `get_api_reference` | The curated public-API surface, grouped by category. |
 | `introspect_source` | Studio: infer an `EntitySchema` from a Drizzle file or sample rows. |
 | `scaffold_entity` | Studio: generate SvelteKit files for a single entity. |
 
+### `check_svgrid_code` - the one a retrieval server cannot do
+
+Reading the docs makes a model *likelier* to be right. This makes it *checkable*.
+Hand it a file and it answers with line-numbered diagnostics and the exact
+replacement for each:
+
+```jsonc
+{
+  "ok": false,
+  "checkedAgainst": "@svgrid/grid@2.6.20",
+  "compiler": "svelte",
+  "counts": { "errors": 3, "warnings": 0, "info": 0 },
+  "diagnostics": [
+    { "rule": "svgrid/renamed-prop", "severity": "error", "line": 24,
+      "message": "`rowData` is not a SvGrid prop.", "fix": "Use `data`." },
+    { "rule": "svgrid/renamed-column-key", "severity": "error", "line": 10,
+      "message": "`accessorKey` is not a SvGrid column key.", "fix": "Use `field`." },
+    { "rule": "svelte/legacy-event-directive", "severity": "error", "line": 30,
+      "message": "`on:rowClick` never fires: SvGrid dispatches no component events, it takes callback props.",
+      "fix": "Use `onRowClick={...}`." }
+  ]
+}
+```
+
+What it checks:
+
+- **Every name, against the installed version.** Importable symbols, `<SvGrid>`
+  props, `ColumnDef` keys, grid API methods, theme stylesheets. The list is
+  generated from the package sources at build time, so it cannot drift from
+  what the package exports, and an unknown name comes back with the nearest
+  real one.
+- **Cross-package mistakes.** A symbol that lives in `@svgrid/enterprise`, or an
+  api method that only exists after `installEnterprise(api)`.
+- **Svelte 5 rules.** `export let` and `$:` in a runes file (compiler errors),
+  `on:` / `<slot>` / `createEventDispatcher` (deprecations), and a plain `let`
+  array that gets mutated and silently never re-renders.
+- **The file, compiled.** When a Svelte compiler is reachable - the user's
+  project copy first, then the one shipped here - real parse errors come back
+  too. The result says which of the two ran in its `compiler` field, so
+  "no errors" is never mistaken for "this compiles".
+
+It is tuned to shut up when the code is right: it reports **nothing** across all
+373 demos in this repo, which is what a CI test asserts. A verifier that cries
+wolf is worse than none, because a model will happily "fix" working code.
+
 ### Studio: drive the app model (agent co-designer)
 
 The `studio_*` tools let an agent build and edit the **same validated project model the visual designer uses** - add entities, screens, blocks, components, wire data sources, theme, RBAC, auth, the typed data layer, and the deploy target - then generate the full runnable app or export the `studio.config.json` the designer can Load. Every edit runs through the model's own functions + `validateProject`, so the agent can't produce an invalid app.
@@ -55,6 +101,20 @@ The `studio_*` tools let an agent build and edit the **same validated project mo
 
 A typical session: `studio_new_project` → `studio_add_entity` (×N) → `studio_set_entity_source` → `studio_set_data_layer` → `studio_set_auth` → `studio_generate_app` → write the files and run `svelte-check`.
 
+## Two ways to run it
+
+| | stdio (this package) | remote HTTP |
+| --- | --- | --- |
+| Install | `npx @svgrid/mcp` | paste a URL |
+| Needs Node | yes | no |
+| `check_svgrid_code` compiles | yes | static checks only |
+| Studio `studio_*` tools | yes (27) | no |
+| Works offline | yes | no |
+
+The remote server lives in [`workers/svgrid-mcp`](../../workers/svgrid-mcp) and
+carries the six docs + verification tools. Use stdio when you want the compiler
+pass, the Studio tools, or no third-party endpoint in the loop.
+
 ## Run
 
 ```bash

package/dist/compile-svelte.d.ts

@@ -0,0 +1,2 @@
+import type { CompileFn } from './validate.js';
+export declare const compileWithSvelte: CompileFn;

package/dist/compile-svelte.js

@@ -0,0 +1,74 @@
+/**
+ * The second gate of `check_svgrid_code`: the real Svelte compiler.
+ *
+ * Kept in its own module, and imported dynamically, for two reasons. The
+ * compiler is only present when the server runs next to a project that has
+ * Svelte installed (a bare `npx @svgrid/mcp` in an empty directory does not),
+ * and a Worker build must be able to leave it out entirely - which it can,
+ * because nothing outside the stdio entry point imports this file.
+ */
+import { createRequire } from 'node:module';
+import { pathToFileURL } from 'node:url';
+import { join } from 'node:path';
+/** Compiler warnings that repeat per element and drown the real findings. */
+const MAX_WARNINGS = 15;
+/**
+ * Prefer the Svelte the USER's project is on, so the check matches what their
+ * build will do; fall back to the copy that ships with this package. Resolved
+ * once and reused - the compiler is not cheap to load.
+ */
+let cached;
+async function loadCompiler() {
+    if (cached !== undefined)
+        return cached;
+    const attempts = [
+        async () => {
+            const require = createRequire(join(process.cwd(), 'package.json'));
+            return (await import(pathToFileURL(require.resolve('svelte/compiler')).href));
+        },
+        async () => (await import('svelte/compiler')),
+    ];
+    for (const attempt of attempts) {
+        try {
+            const mod = await attempt();
+            if (typeof mod.compile === 'function') {
+                cached = mod;
+                return cached;
+            }
+        }
+        catch {
+            // Try the next source.
+        }
+    }
+    cached = null;
+    return cached;
+}
+export const compileWithSvelte = async (source, filename) => {
+    const mod = await loadCompiler();
+    if (!mod)
+        return { available: false, diagnostics: [] };
+    const compile = mod.compile;
+    const diagnostics = [];
+    try {
+        const { warnings } = compile(source, { filename, generate: 'client' });
+        for (const w of warnings.slice(0, MAX_WARNINGS)) {
+            diagnostics.push({
+                rule: `svelte/${w.code ?? 'warning'}`,
+                severity: 'warning',
+                line: w.start?.line ?? 1,
+                message: w.message ?? 'compiler warning',
+            });
+        }
+    }
+    catch (err) {
+        const e = err;
+        diagnostics.push({
+            rule: `svelte/${e.code ?? 'compile-error'}`,
+            severity: 'error',
+            line: e.start?.line ?? 1,
+            message: (e.message ?? String(err)).split('\n')[0],
+            fix: 'The file does not parse. Fix this first - every other check ran on unparsed text.',
+        });
+    }
+    return { available: true, diagnostics };
+};

package/dist/data.d.ts

@@ -0,0 +1,31 @@
+import type { ApiSurface } from './validate.js';
+export type ExampleEntry = {
+    id: string;
+    path: string;
+    title: string;
+    category: string;
+    blurb: string;
+    source: string;
+};
+export type DocEntry = {
+    slug: string;
+    path: string;
+    title: string;
+    section: string;
+    markdown: string;
+};
+export declare const examples: readonly ExampleEntry[];
+export declare const docs: readonly DocEntry[];
+export declare const apiReference: {
+    readonly components: readonly ["SvGrid", "SvGridBoard", "FlexRender", "renderComponent", "renderSnippet"];
+    readonly headless: readonly ["createSvGrid", "createGrid", "createGridState", "subscribeGrid", "createTable"];
+    readonly scheduler: readonly ["registerSchedulerView", "getSchedulerView", "hasSchedulerView", "resolveEvents", "layoutDayEvents"];
+    readonly dataOps: readonly ["applyGroupAggregate", "filterFns", "sortFns"];
+    readonly export: readonly ["serializeDelimited", "serializeJson", "serializeHtml", "serializeMarkdown", "downloadTextFile", "copyTextToClipboard"];
+    readonly rowModels: readonly ["createCoreRowModel", "createFilteredRowModel", "createSortedRowModel", "createGroupedRowModel", "createExpandedRowModel", "createPaginatedRowModel"];
+    readonly features: readonly ["tableFeatures", "rowSortingFeature", "columnFilteringFeature", "columnGroupingFeature", "rowExpandingFeature", "rowPaginationFeature", "rowSelectionFeature"];
+    readonly virtualization: readonly ["createVirtualizer", "createSvelteVirtualizer", "createColumnVirtualizer"];
+    readonly accessibility: readonly ["getGridRootA11yProps", "getGridHeaderA11yProps", "getGridCellA11yProps", "getGridRowA11yProps", "getGridCellDomId"];
+    readonly utilities: readonly ["getKeyboardIntent", "getNextActiveCell", "parseEditorValue", "applyExcelFilter", "formatNumericWithConfig", "resolveDatePattern"];
+};
+export declare const apiSurface: ApiSurface;