@bicharts/chart-mcp 0.3.5 → 0.5.49

package/README.md

@@ -1,13 +1,22 @@
 # @bicharts/chart-mcp (experimental)
 
-An MCP (Model Context Protocol) stdio server that lets any MCP-capable AI client
-(Claude Code, Claude Desktop, Copilot Studio, Cursor, …) use the BIC chart engine:
+> **Make Generative AI for Charts *Better*.**
+
+An MCP (Model Context Protocol) stdio server that puts **RegiaBI** behind any
+MCP-capable AI client (Claude Code, Claude Desktop, Copilot Studio, Cursor, …).
+
+What that buys you: a working, interactive chart that **fits your data on the first
+try** — real source you commit, with no D3, Vega or charting-API expertise in the
+loop, and a solid starting point to adjust rather than a blank page. Because the
+engine knows what ~90 chart types can honestly say, it will sometimes propose a view
+— or a measure — you had not thought to ask for. Three tools:
 
 - **`assess_data_shape`** — profiles a CSV **locally** with the same measurement
   engine the Power BI visual uses (`@bicharts/shape-core`). No backend call, no
   credentials, no data leaves the machine. The free-teaser tool.
 - **`list_eligible_charts`** — the **authoritative** list of chart types that can
-  render this data (server-side policy, not a local guess; **zero-credit**, no LLM).
+  render this data (server-side policy, not a local guess; **no LLM**, but a network
+  call to the engine and therefore **metered** — see Credentials).
   By default it **auto-detects the project's language** (JS/TS vs Python from the
   working dir) and returns the charts for THAT language — **scoped to its renderers
   and ranked by the picker's chart-type×renderer weights** (best first), each tagged
@@ -16,8 +25,10 @@ An MCP (Model Context Protocol) stdio server that lets any MCP-capable AI client
   `renderer: "D3"/"PLOTLY"/…` to rank one specific renderer, or `renderer: ""` for the
   full **renderer-agnostic** eligibility across all renderers (unranked — the wide "what
   *can* render" net). `top: N` trims to the best N. If the language can't be auto-detected
-  and none is given, the tool asks you to specify one. Credentials optional (a license
-  only unlocks *draft* types).
+  and none is given, the tool asks you to specify one. **Credentials required** — no LLM
+  is not the same as no cost, because eligibility *is* the engine's own answer. Free within
+  a generous hourly allowance; beyond it a call may draw usage credits. A live licence
+  additionally unlocks *draft* types.
 - **`generate_chart`** — profiles locally, then calls the BIC backend, which picks
   an eligible chart type for the measured shape (or honors `chart_type`) and
   returns code that has passed the backend's gates/QC. Renderer selection is the same
@@ -96,12 +107,20 @@ npm install
 npm run build     # bundles to dist/index.mjs (single file)
 ```
 
-## Credentials (generate_chart only)
+## Credentials (`generate_chart` and `list_eligible_charts`)
 
 **A trial or paid BIC account is required — no freemium.** Use the same
 **License Key**, **Licensee**, and **Secret Key** from your BIC account (the ones
-the Power BI visual's license settings use). `assess_data_shape` needs no
-credentials at all (it runs entirely locally).
+the Power BI visual's license settings use).
+
+`assess_data_shape` needs no credentials at all — it runs entirely locally in
+`@bicharts/shape-core` and never calls the backend. `list_eligible_charts` **does**
+need them: it is the server's own eligibility verdict, not a local guess, which is
+the whole reason it is worth calling. It is free within a generous hourly allowance;
+beyond that, a call may draw usage credits from the account (both knobs are
+server-configured), so don't put it inside a tight loop. Use of the API and this MCP
+server is covered by the
+[RegiaBI Programmatic Access Terms](https://bizintelligencechampions.com/terms-regiabi).
 
 Two ways to supply them — env wins over the file: