@kanunilabs/mcp 0.0.0-stage → 1.0.0

package/package.json

@@ -1,6 +1,52 @@
 {
   "name": "@kanunilabs/mcp",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "1.0.0",
+  "description": "MCP server that gives AI coding assistants the KanuniLabs DataGrid and PivotGrid documentation and API reference. Runs locally over stdio; the docs ship inside the package, nothing is fetched.",
+  "license": "SEE LICENSE IN LICENSE",
+  "author": "KanuniLabs <hello@kanunilabs.com> (https://www.kanunilabs.com)",
+  "homepage": "https://kanunilabs.com/docs/datagrid/ai-assistants",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kanunilabsdev/support.git"
+  },
+  "bugs": {
+    "email": "hello@kanunilabs.com",
+    "url": "https://github.com/kanunilabsdev/support/issues"
+  },
+  "type": "module",
+  "bin": {
+    "kanunilabs-mcp": "./dist/cli.js"
+  },
+  "files": [
+    "dist",
+    "data",
+    "skill",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@modelcontextprotocol/sdk": "1.30.1",
+    "zod": "4.6.5"
+  },
+  "keywords": [
+    "mcp",
+    "model-context-protocol",
+    "ai",
+    "datagrid",
+    "pivotgrid",
+    "documentation",
+    "kanunilabs"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "corpus": "node scripts/build-corpus.mjs",
+    "lint": "tsc --noEmit",
+    "build:check": "tsc --noEmit",
+    "test": "vitest run"
+  }
 }

package/skill/kanunilabs-grids/SKILL.md

@@ -0,0 +1,155 @@
+---
+name: kanunilabs-grids
+description: Use when writing or changing code that uses the KanuniLabs DataGrid or PivotGrid (any @kanunilabs/* package) — choosing the package, installing it, setting props and options, the Enterprise licence key, the Web Worker and Content-Security-Policy, Next.js, and upgrading between versions.
+---
+
+# KanuniLabs DataGrid and PivotGrid
+
+Two data components for React and for plain JavaScript. Sorting, filtering and
+aggregation run in a Web Worker that is compiled into the package.
+
+## Look names up, do not guess them
+
+A prop or option name that looks right but does not exist does nothing at
+runtime and raises no error (TypeScript catches some, not untyped objects).
+Before you write one, check it:
+
+- With the `kanunilabs` MCP server connected (`npx -y @kanunilabs/mcp`): call
+  `get_api` with `Symbol` or `Symbol.member` (`DataGridProps.columns`,
+  `PivotLayoutState.showColumnTotals`), `search_docs` for a question in words,
+  `get_doc` to read a guide, `get_changes` before an upgrade.
+- Without it: https://www.kanunilabs.com/llms.txt (index) and
+  https://www.kanunilabs.com/llms-full.txt (every guide in one file); the API
+  reference is at `/docs/datagrid/api` and `/docs/pivotgrid/api`.
+
+## Pick the package
+
+| Need | DataGrid | PivotGrid |
+|---|---|---|
+| React, free | `@kanunilabs/datagrid-react` | `@kanunilabs/pivotgrid-react` |
+| Plain JavaScript, free | `@kanunilabs/datagrid` (`createGrid()`) | `@kanunilabs/pivotgrid` (`createPivotGrid()`) |
+| React, paid | `@kanunilabs/datagrid-react-enterprise` | `@kanunilabs/pivotgrid-react-enterprise` |
+| Plain JavaScript, paid | `@kanunilabs/datagrid-enterprise` (`createEnterpriseGrid()`) | `@kanunilabs/pivotgrid-enterprise` (`createEnterprisePivotGrid()`) |
+
+- The free (Community) packages are on public npm and need no key. A
+  renderer pulls in its core (`…-core`); there is no need to install it.
+- The paid (Enterprise) packages are NOT on public npm. They install from
+  `https://registry.kanunilabs.com/` with the `.npmrc` the buyer receives. Do
+  not tell someone without a licence to `npm i` one; it will fail.
+- When you use an Enterprise feature, say that it needs the paid package. The
+  Enterprise component takes the place of the free one: `EnterpriseDataGrid`
+  for `DataGrid` (same props, plus its own), `EnterprisePivotGrid` for
+  `BasePivotGrid`.
+- One licence key covers both products.
+
+## Minimal setup
+
+DataGrid (React):
+
+```tsx
+import { DataGrid, type ReactGridColumnDef } from '@kanunilabs/datagrid-react';
+import '@kanunilabs/datagrid-react/styles.css';
+
+const columns: ReactGridColumnDef<Sale>[] = [
+  { field: 'id', headerName: 'ID', dataType: 'number', width: 80 },
+  { field: 'product', headerName: 'Product' },
+  { field: 'revenue', headerName: 'Revenue', dataType: 'number' },
+];
+
+<DataGrid gridId="sales" dataSource={rows} rowKey="id" columns={columns} style={{ height: 600 }} />;
+```
+
+- `rowKey` is required: selection and focus follow row identity.
+- Give the grid a height (as above); rows are virtualized inside it.
+
+PivotGrid (React):
+
+```tsx
+import { BasePivotGrid, type PivotField } from '@kanunilabs/pivotgrid-react';
+import '@kanunilabs/pivotgrid-react/styles.css';
+
+const fields: PivotField<Row>[] = [
+  { id: 'region', dataField: 'region', caption: 'Region', dataType: 'string', area: 'row' },
+  { id: 'quarter', dataField: 'quarter', caption: 'Quarter', dataType: 'string', area: 'column' },
+  { id: 'revenue', dataField: 'revenue', caption: 'Revenue', dataType: 'number', area: 'data', summaryType: 'sum' },
+];
+
+<BasePivotGrid gridId="sales" data={rows} initialFields={fields} />;
+```
+
+- `area` is `'row' | 'column' | 'data' | 'filter'`; measures need a `summaryType`.
+- The grid fills its container. Give the container a height for a grid that
+  scrolls inside; without one it is as tall as its content.
+- The React package has peer dependencies `@dnd-kit/core`, `lucide-react` and
+  `zustand` (npm 7+ installs them).
+
+Import each stylesheet once, near the app root. With an Enterprise package,
+import its stylesheet too, after the free one:
+
+```ts
+import '@kanunilabs/datagrid-react/styles.css';
+import '@kanunilabs/datagrid-react-enterprise/styles.css';
+```
+
+## Licence key (Enterprise only)
+
+Set it once at startup, before the first grid renders (React):
+
+```tsx
+import { LicenseManager } from '@kanunilabs/datagrid-react-enterprise';
+// or from '@kanunilabs/pivotgrid-react-enterprise'
+LicenseManager.setLicenseKey(key); // keys start with "KLAB1."
+```
+
+- Never put a real key in code you show or commit. Read it from the app's
+  configuration.
+- Without a valid key the grid still works and shows a watermark badge saying
+  why. Do not treat the badge as a crash.
+- `localhost` still needs the key; only the domain check is skipped there.
+- To react to the licence state in code, read `reasonCode` (from
+  `useLicenseGuard()`, exported by both React Enterprise packages) rather than
+  parsing the `reason` text.
+
+## Worker and Content-Security-Policy
+
+Nothing to configure: the worker starts from a `blob:` URL in every bundler
+(Vite, webpack, Next.js, Parcel). Do not add a copy-the-worker step.
+
+Only under a Content-Security-Policy, allow it with
+`worker-src 'self' blob:`. If the policy cannot change, serve the worker file
+from the app's own origin (PivotGrid first tries the packaged file by itself):
+
+- DataGrid: `node_modules/@kanunilabs/datagrid-core/dist/datagrid.worker.js`,
+  passed as `worker={{ url: '/datagrid.worker.js' }}`.
+- PivotGrid: `node_modules/@kanunilabs/pivotgrid-core/dist/pivot.worker.js`,
+  passed as `workerUrl="/pivot.worker.js"`.
+
+A copied worker must be copied again on every upgrade (a `postinstall` script
+does it). With Vite, import it as `…/dist/datagrid.worker.js?url` instead.
+
+## Next.js
+
+- DataGrid renders on the server and hydrates: mark the file that renders it
+  `'use client'`; no `ssr: false` needed.
+- PivotGrid renders on the client only: load the component that renders it
+  with `dynamic(() => import('./MyGrid'), { ssr: false })` from a
+  `'use client'` file.
+
+## Export
+
+- DataGrid: CSV export is free and needs nothing. Excel and PDF export are
+  Enterprise; `.xlsx` also needs the optional peer `exceljs` (`npm i exceljs`),
+  loaded only when an export runs.
+- PivotGrid: `excel-list`, `excel-pivot` and `pdf` need the Enterprise
+  package; CSV, JSON, XML, print and clipboard are free.
+
+## Upgrading
+
+- Upgrade every `@kanunilabs/<product>*` package the app lists in one command,
+  to the versions of one release. The Enterprise packages pin an exact
+  version of the free ones; a package left behind installs a second copy of
+  the engine, and a licence key set through one copy is not seen by the other.
+  Check with `npm ls @kanunilabs/datagrid-core` (or `pivotgrid-core`): one
+  version is right.
+- Read what each version asks of an app before upgrading: the `get_changes`
+  tool, or `/docs/datagrid/upgrading` and `/docs/pivotgrid/upgrading`.