@slickfast/mcp - npm Package Compare versions

Comparing version 0.7.22 to 0.7.23

package.json

 {
   "name": "@slickfast/mcp",
-  "version": "0.7.22",
+  "version": "0.7.23",
   "mcpName": "com.slickfast/mcp",
@@ -15,3 +15,3 @@ "homepage": "https://slickfast.com",
   },
-  "description": "SlickFast — render 47 chart & info-design types (bar, line, pie, KPI, cards, funnel, matrix, gauge, calendar…) plus multi-chart dashboards tiled into one image, as SVG/PNG via MCP. Local and deterministic; nothing leaves your machine.",
+  "description": "SlickFast MCP — JSON → charts, dashboards, and Pages. Twin at .json, fingerprint on the Page. News and Get started in chat. Local by default; share/publish with a free key.",
   "keywords": [
@@ -18,0 +18,0 @@ "mcp",

README.md

@@ -1,2 +0,2 @@
-# SlickFast — charts & dashboards for AI agents
+# SlickFast — charts, dashboards & Pages for AI agents
 
@@ -12,9 +12,11 @@ [![npm version](https://img.shields.io/npm/v/@slickfast/mcp?color=22d3ee&label=npm)](https://www.npmjs.com/package/@slickfast/mcp)
 
-**JSON in → chart or whole Page out.** No browser, no Puppeteer. Same spec, same picture, every time.
-Runs as an [MCP](https://modelcontextprotocol.io) tool — **100% local**, nothing leaves your machine
-until you ask to share or publish.
+**JSON in → chart, dashboard, or a whole Page out.** No browser. No Puppeteer. Same
+spec, same bytes, forever. Runs as an [MCP](https://modelcontextprotocol.io) tool —
+**local by default**; nothing leaves your machine until you ask to share or publish.
 
-**47 types** (bar, line, pie, KPI, funnel, gauge, heatmap, calendar…) plus **multi-chart dashboards
-in one call**. Also: **Pages** (designed docs), **News**, and **Get started** — all as live Pages,
-not baked copy.
+Most tools draw a picture and throw the recipe away. SlickFast **keeps the recipe.**
+The spec **is** the chart. A pagespec **is** a public Page. Add **`.json`** — that’s
+the **twin**. The **fingerprint** (`sha256`) is on the Page. People open the URL.
+Agents fetch the twin. [News](https://slickfast.com/news) lands in chat via the
+`news` tool — same drop, two doors.
 
@@ -24,10 +26,40 @@ ```txt
   → retina PNG (or SVG) on your machine
+
+describe_pagespec() → render_page({ page: { … } })
+  → self-contained HTML on your machine (local twin: save the pagespec JSON)
+
+publish_page({ page: { … } })
+  → https://api.slickfast.com/s/{slug}  +  .json twin  +  fingerprint
 ```
 
-More pictures: [slickfast.com](https://slickfast.com) · start here: [slickfast.com/start](https://slickfast.com/start) · what’s shipping: [slickfast.com/news](https://slickfast.com/news)
+**47 chart types** + **multi-chart dashboards in one call.** Plus **Pages**, **News**,
+and **Get started** — live Pages, not baked README paste.
 
+Site: [slickfast.com](https://slickfast.com) · first minute: [slickfast.com/start](https://slickfast.com/start) · what’s shipping: [slickfast.com/news](https://slickfast.com/news)
+
+## Pages (the document, not just the picture)
+
+A **Page** is a designed web document from one JSON **pagespec** — hero, prose, charts,
+layout. Publish once:
+
+| Door | Who | What |
+|---|---|---|
+| Page URL | Humans | The document |
+| URL + `.json` | Agents | The **twin** — exact recipe |
+| `sha256:` in the chrome | Both | **Fingerprint** — prove HTML ↔ twin |
+
+**Local:** `describe_pagespec` → `render_page` (optional `pagespecPath` / `outputPath`).
+No key. Open the HTML in a browser. Save the pagespec beside it as your local twin.
+
+**Public:** `publish_page` needs a free or paid [SF- key](https://slickfast.com).
+Free: up to **5 Pages** alive, **7-day** TTL, watermark. Paid: more slots, **permanent**.
+`DELETE /pages/{slug}` frees a slot.
+
+**In chat:** call `news` or `get_started` — current drops are Pages behind
+[slickfast.com/news](https://slickfast.com/news) and [slickfast.com/start](https://slickfast.com/start).
+
 ## Install
 
-> Renders locally and privately for free. Public URLs / live embeds need a free API key at
-> [slickfast.com](https://slickfast.com) (no card).
+> Renders locally and privately for free. Public URLs / live embeds / published Pages
+> need a free API key at [slickfast.com](https://slickfast.com) (no card).
 
@@ -50,6 +82,6 @@ **One-click:**
 **First clicks** (prompts in clients that show them): **Get started** → **Try SlickFast** →
-**Build a dashboard**. Also: **SlickFast News**, **Update / refresh SlickFast**, **Make a Page**,
-**Share / publish**, **Report a SlickFast issue**.
+**Build a dashboard**. Also: **SlickFast News**, **Make a Page**, **Share / publish**,
+**Update / refresh SlickFast**, **Report a SlickFast issue**.
 
-Or say: *"Show me what SlickFast can do"* · *"what's new"* · *"get me started"*.
+Or say: *"get me started"* · *"what's new"* · *"make a Page"* · *"Show me what SlickFast can do"*.
 
@@ -61,20 +93,15 @@ **Stuck?** Restart the client · Node 18+ · one stray comma breaks JSON ·
 
+- **`get_started()`** → live onboarding Page ([slickfast.com/start](https://slickfast.com/start)). Keyless. Best first call.
+- **`news()`** → live News Page ([slickfast.com/news](https://slickfast.com/news)). Keyless.
+- **`describe_pagespec()`** → Pages contract (hero, prose, charts, themes, twin, slots).
+- **`render_page(pagespec)`** → self-contained HTML, **local**. Optional `pagespecPath` / `outputPath`.
+- **`publish_page(pagespec)`** → public URL + `.json` twin + fingerprint (free = 5 concurrent · 7d + watermark; paid = permanent).
 - **`render_chart(spec)`** → PNG (default) or SVG. Dashboards: `type: "dashboard"` with
-  `tiles: [{ chart, span }]` — one image, one call. Tiles **fill** the cell by default.
-  Local: `specPath` loads JSON from disk (dense boards); response includes a `layout:` sidecar.
-- **`describe_type(type)`** → data shape, minimal spec, gotchas. Call when unsure.
-- **`gallery()`** → curated demos (images + specs). `board:"comparison"` / `board:"all"` for boards.
-- **`list_palettes()`** → every valid `palette` name and colors, plus one swatch-board PNG
-  (flat + nested; dark themes on a dark strip). Keyless.
-- **`share_chart(spec, name?)`** → public / live embed URL via the hosted API (free key).
-  Rendering stays local; offer only when asked to share.
-- **`read_chart(url)`** → spec twin of any SlickFast chart URL.
+  `tiles: [{ chart, span }]`. Tiles **fill** the cell by default. Local: `specPath` + `layout:` sidecar.
+- **`describe_type(type)`** → data shape, minimal spec, gotchas.
+- **`gallery()`** → curated demos. `board:"comparison"` / `board:"all"`.
+- **`list_palettes()`** → palette names + hex + one swatch-board PNG. Keyless.
+- **`share_chart(spec, name?)`** → public / live chart URL (free key). Offer when asked to share.
+- **`read_chart(url)`** → spec twin of a SlickFast chart URL.
 - **`push_to_trmnl(spec, webhook_url)`** → e-ink PNG to a [TRMNL](https://usetrmnl.com) display.
-- **`describe_pagespec()`** → Pages contract (hero, prose, charts, themes, drill-downs).
-- **`render_page(pagespec)`** → self-contained HTML, local. Optional `outputPath`.
-- **`publish_page(pagespec)`** → public Page URL + `.json` twin (free = short TTL + watermark;
-  paid = permanent).
-- **`news()`** → live twin behind [slickfast.com/news](https://slickfast.com/news). Keyless.
-- **`get_started()`** → live onboarding Page behind [slickfast.com/start](https://slickfast.com/start).
-  Keyless. Best first tool after install.
 - **`mcp_status()`** → this package version + how to refresh (facts only, no nag).
@@ -87,3 +114,4 @@ - **`report_issue(summary, spec?)`** → draft GitHub / email links. SlickFast sends nothing.
 - **One-field edits** — swap type, palette, size; re-render. No code rewrite.
-- **No headless browser** — pure in-memory SVG → PNG.
+- **Pages = shareable memory** — agent output → Page → twin → fingerprint. Not stuck in chat.
+- **No headless browser** — pure in-memory SVG → PNG (and Page HTML).
 - **Deterministic** — same spec, same bytes. Cacheable. Testable.
@@ -95,22 +123,21 @@ - **Loud errors** — bad enum / unknown palette lists the valid options.
 
-- Prefer **`format:"svg"`** when the chat supports artifacts (claude.ai / Claude Desktop) —
-  most reliable inline path.
+- Prefer **`format:"svg"`** when the chat supports artifacts (claude.ai / Claude Desktop).
 - **`format:"png"`** needs a client that paints MCP image blocks (inconsistent).
-- Local disk: pass **`outputPath`**. Hosted/sandbox MCP often can’t show that file — use SVG
+- Local disk: **`outputPath`**. Hosted/sandbox often can’t show that file — use SVG
   or **`share_chart`** / **`publish_page`** for a URL.
 
 If values came back but no picture, it rendered — display surface gap, not a broken engine.
-Re-ask for SVG into an artifact, or open a Share URL.
 
 ## Share & live embeds
 
-Ask to **share** or **publish**. Needs `SLICKFAST_API_KEY` in the MCP config (free at
-[slickfast.com](https://slickfast.com)). The live board at the top of this README is that
-pattern: one public URL, push new data, every embed updates.
+Ask to **share** a chart or **publish** a Page. Needs `SLICKFAST_API_KEY` in the MCP config
+(free at [slickfast.com](https://slickfast.com)). The live board at the top of this README
+is that pattern: one public URL, push new data, every embed updates.
 
 ## License
 
-**AGPL-3.0-only.** Local / self-host / embed under AGPL is fine. Closed-source product or
-hosted service → open the AGPL’d source, or a **commercial license**:
+**AGPL-3.0-only.** Local / self-host / embed under AGPL is fine. Closed-source product →
+open the AGPL’d source, or a **commercial license**:
 [slickfast.com/license.html](https://slickfast.com/license.html) · [e-mail].
+Hosted API / hosted MCP stay on [API pricing](https://slickfast.com/#pricing) — service, not that license.
 
@@ -117,0 +144,0 @@ ## Feedback

New alerts

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Fixed alerts

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Improved metrics

Total package byte prevSize

369394

1.11%

Lines of code

4909

0.8%

Number of lines in readme file

153

21.43%

No dependency changes