Skip to content

Connect AI

Use ChartBuddy Embed (@chartbuddy.io/embed) from AI clients: HTML pages, artifacts, dashboards, and slide decks. Agents mount charts with new Insight() – there is no remote Embed API or MCP server for the npm package itself.

Agent-readable references

Give your client these stable URLs:

  • llms.txt – compact package guide (start here)
  • Embed docs – full documentation (this site)
  • Visual QA – mount, observe, fix layout and config

Need desktop Hub editing over MCP (open charts in Chartbuddy Hub, list_charts, …)? See Chartbuddy Hub – Connect MCP.

How Embed fits AI workflows

  1. Read llms.txt and/or fetch docs (Installation → Quick start → host sizing).
  2. Write HTML/JS that imports @chartbuddy.io/embed and passes chartData.
  3. Size the host – definite width/height (aspect-ratio or fixed px). See Canvas & sizing.
  4. Verify with Visual QA – layout first, then annotations.

Pick your client

ClientGuide
CursorConnect Cursor
Claude CodeConnect Claude Code
OpenCodeConnect OpenCode
ChatGPT / CodexConnect ChatGPT / Codex
ChatGPTConnect ChatGPT
ClaudeConnect Claude

Shared handoff

Paste into a new agent chat when starting an Embed task:

text
Build ChartBuddy Embed charts with @chartbuddy.io/embed (new Insight()).
Read https://unpkg.com/@chartbuddy.io/embed/llms.txt and https://chartbuddy.io/embed/docs/getting-started/quick-start
Host sizing: mount element needs definite width/height (prefer width + aspect-ratio, not height:100% in flex/slide layouts).
Use validateChartData / Visual QA loop before declaring done.

Troubleshooting

SymptomCheck
Charts render tiny or letterboxedHost sizing – aspect-ratio or fixed px
format changes do nothingSet numberFormat: { mode: 'custom', customFormat } – see Number formats
Agent invents wrong APInew Insight() only – not Chart.js / createChart
Slide deck charts wrong sizeMount when slide is visible; remount or update after layout
Need Hub window toolsUse Hub Connect MCP instead of Embed docs alone

Developer documentation for ChartBuddy Embed · Not the end-user Help Center · Help Center