@bicharts/chart-mcp 0.6.34 → 0.6.45

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -47,7 +47,7 @@ only render text); `structuredContent` is for code, so nothing has to string-par
47
47
 
48
48
  | field | |
49
49
  | --- | --- |
50
- | `code` | the `render()` source (omitted when `include_code: false`) |
50
+ | `code` | the `render()` source (omitted when `include_code: false`, which is the default when `out_dir` is given - the code is then on disk) |
51
51
  | `chartName`, `language`, `version`, `creditCost` | what was produced, and what it cost |
52
52
  | `correlationId` | the handle into the server-side log — quote it in any support request |
53
53
  | `outputHash` | the server's identity for this exact code (the same code always carries the same hash) — keep it with the chart |
@@ -201,18 +201,50 @@ visual (the MCP hits the same billed endpoint):
201
201
 
202
202
  The response header line shows `credits: N` so you can see what each call cost.
203
203
 
204
+ ## Telemetry
205
+
206
+ The server tells the BIC service three things, and nothing else:
207
+
208
+ - **A usage counter** for each call of `list_eligible_charts` and `generate_chart` that reaches the
209
+ service: the tool's name, this server's client version and a random nonce. No data, no account,
210
+ no machine identity.
211
+ - **One row when `generate_chart` returns code**, joined to the generation the service already
212
+ logged (by its output hash) and marked as delivered through the MCP: the call's duration, the
213
+ row count, the requested language and this server's build. It records that the code was handed
214
+ over, never that anyone drew it.
215
+ - **One row when a generation fails after the service answered**, carrying the service's own message.
216
+
217
+ `assess_data_shape` never sends anything - it profiles your data locally, telemetry on or off.
218
+
219
+ Set `BIC_MCP_TELEMETRY=0` in the server's environment to turn all of it off.
220
+
204
221
  ## The agent skill (recommended)
205
222
 
206
223
  This package ships `skills/bic-charts/SKILL.md` — the golden path from empty directory to a
207
224
  working cross-filtered dashboard: the scaffold command block, when to use the authoritative
208
225
  contract parameters instead of `prompt` prose, the coordinated-dashboard recipe, and the
209
- handful of places builds measurably lose time. Copy it where your agent looks for skills:
226
+ handful of places builds measurably lose time. Copy it where your agent looks for skills, in the
227
+ folder you'll work in. `npx` keeps the package in its own cache, not under `npm root`, so unpack
228
+ it from the registry instead:
210
229
 
211
230
  ```powershell
231
+ $tgz = npm pack @bicharts/chart-mcp
232
+ tar -xzf $tgz
212
233
  mkdir -Force .claude\skills
213
- Copy-Item -Recurse (npm root)\@bicharts\chart-mcp\skills\bic-charts .claude\skills\
234
+ Copy-Item -Recurse package\skills\bic-charts .claude\skills\
235
+ Remove-Item -Recurse package, $tgz
236
+ ```
237
+
238
+ ```bash
239
+ tgz=$(npm pack @bicharts/chart-mcp 2>/dev/null)
240
+ tar -xzf "$tgz"
241
+ mkdir -p .claude/skills && cp -r package/skills/bic-charts .claude/skills/
242
+ rm -rf package "$tgz"
214
243
  ```
215
244
 
245
+ (PowerShell does not expand a `*` for `tar`, so `tar -xzf bicharts-chart-mcp-*.tgz` fails there;
246
+ capturing the file name `npm pack` prints works in both shells.)
247
+
216
248
  An agent that reads it first does in a few calls what otherwise takes thirty — most of the
217
249
  difference is not knowing the API, it is not knowing the shape of the answer.
218
250