@bicharts/chart-mcp 0.1.1 → 0.2.1

package/README.md

@@ -28,6 +28,25 @@ An MCP (Model Context Protocol) stdio server that lets any MCP-capable AI client
   you can open with no build step. It is **off by default** — the code is meant to be
   merged into your app, not run as an index.html.
 
+## generate_chart's machine-readable result
+
+`generate_chart` answers on two channels. The text block is for a human (and for hosts that
+only render text); `structuredContent` is for code, so nothing has to string-parse
+`--- code ---` out of prose:
+
+| field | |
+| --- | --- |
+| `code` | the `render()` source (omitted when `include_code: false`) |
+| `chartName`, `language`, `version`, `creditCost` | what was produced, and what it cost |
+| `correlationId` | the handle into the server-side log — quote it in any support request |
+| `requiredD3Plugins` | packages the code calls, e.g. `["d3-sankey"]` — install and `Object.assign` them onto the **same** d3 you pass the host, or the chart throws mid-render |
+| `geo` / `geoPoint` | region/basemap wiring, and how many points actually placed |
+| `data` **or** `files` | the render payload inline, **or** the paths written — never both |
+| `hostContract`, `build` | the contract the code targets, and the bundle that served the call |
+
+`data` carries the appended `__geoIso__` / `__geoLat__` / `__geoLon__` columns, which a caller
+cannot reconstruct from the source data — so a geo chart needs either it or `files.data`.
+
 ## Language & renderer
 
 Both list/generate tools speak **language** (what your project is written in) as well as