Skip to content
streamboard docs

Claude Code

Claude Code connects to the streamboard MCP server at mcp.usestreamboard.com over Streamable HTTP. From there, the assistant can author dashboards (KPI tiles, charts, tables) and inspect their history. Live-data pushes happen from your own code via @streamboard/sdk or the CLI.

Setup

Section titled “Setup”

Add the following to your project’s .mcp.json:

{
  "mcpServers": {
    "streamboard": {
      "type": "http",
      "url": "https://mcp.usestreamboard.com/mcp"
    }
  }
}

Or run:

Terminal window
claude mcp add streamboard --transport http https://mcp.usestreamboard.com/mcp

Authenticate via OAuth on first use.

What you can ask for

Section titled “What you can ask for”

Each prompt below maps to the corresponding MCP tool call. Claude Code routes them automatically.

  • Author a streamboard — “Build me a streamboard with four KPI tiles (MRR, active users, churn, NPS) and a weekly-signups area chart. Make the chart data bindable so I can push fresh values.” (create_streamboard)
  • Iterate — “Add a ‘Top regions’ bar chart underneath the existing tiles.” (update_streamboard, mints a new version)
  • Inspect — “Show me the current spec of streamboard <id> and explain what each section does.” (get_streamboard)
  • Inspect live data — “What data is currently pushed to streamboard <id>, and do my bindable slots line up with it?” (get_streamboard_data)
  • History — “List every version of streamboard <id> and who authored each.” (list_versions)
  • Tidy up — “Delete streamboard <id>.” (delete_streamboard, owner / org admin only)

The MCP tool description lists the full json-render component catalog (KPI, StatGrid, LineChart, AreaChart, BarChart, PieChart, plus shadcn primitives like Card, Stack, Grid, Heading, Text, Alert, Badge), so Claude picks the right component for the job without you naming it.

CLI companion

Section titled “CLI companion”

For everything that doesn’t fit an MCP tool — listing your boards, pushing data, generating types — use the streamboard CLI:

Terminal window
npx streamboard streamboards ls
npx streamboard streamboards push <id> --state '{"kpis":{"mrr":{"value":"$48k"}}}'
npx streamboard streamboards codegen <id> --out src/streamboard.generated.ts

The generated file exports typed push() + pull() helpers wired to your spec’s bindable slots.