API Reference

Board

A kanban of cards grouped into columns by status or stage — each card carries a title, assignee, tags, and typed refs.

A Board is a kanban — cards grouped into columns by status or stage. Each card has a title, an optional body, an assignee, tags, and typed references. It renders polished lanes for humans and hands an agent the structured board behind it: every card's status, owner, and refs as data, never a screenshot of a board to interpret. Kanban is an alias for the same component.

Preview

Todo

2
Draft knowledge schema
mcp
Token audit
design

In progress

1
Build the extractor
Krishnan

Done

1
Lock the brand
Krishnan

When to use it

Pipelines, sprint boards, intake queues, review states — anything where items move through stages and the question is "what's in each column, and who owns it?" The agent gets the columns and cards directly, so it can answer "everything blocked" or "Krishnan's in-progress cards" without reading a picture.

Props

Board (alias Kanban)

PropTypeDefaultDescription
columnsBoardColumnInput[]The lanes, in display order
labelstring"Board"Accessible name for the board

BoardColumnInput

FieldTypeDescription
titlestringColumn header
statusStatusOptional lane status — colours the dot
cardsBoardCardInput[]The cards in this column, in order

BoardCardInput

FieldTypeDescription
titlestringCard title
bodyReactNodeOptional detail under the title
statusStatusOptional per-card status
assigneestringOwner chip
tagsstring[]Chips
refs{ rel?, target, label? }[]Typed links rendered as pill-links

Status is one of planned · in-progress · blocked · done · deprecated · proposed · accepted · rejected · superseded.

What the agent sees

get_component_data returns the columns and cards as data — statuses are the shared enum, the assignee and tags are intact, and the ref resolves as internal:

{
  "kind": "board",
  "id": "extraction-board",
  "title": "Extraction board",
  "columns": [
    {
      "id": "todo",
      "title": "Todo",
      "status": "planned",
      "cards": [
        { "id": "draft-knowledge-schema", "title": "Draft knowledge schema", "tags": ["mcp"] },
        { "id": "token-audit", "title": "Token audit", "tags": ["design"] }
      ]
    },
    {
      "id": "in-progress",
      "title": "In progress",
      "status": "in-progress",
      "cards": [
        {
          "id": "build-the-extractor",
          "title": "Build the extractor",
          "status": "in-progress",
          "assignee": "Krishnan",
          "refs": [
            { "rel": "related", "target": "/docs/agents/mcp", "label": "MCP", "internal": true }
          ]
        }
      ]
    },
    {
      "id": "done",
      "title": "Done",
      "status": "done",
      "cards": [
        {
          "id": "lock-the-brand",
          "title": "Lock the brand",
          "status": "done",
          "assignee": "Krishnan"
        }
      ]
    }
  ]
}

Status is shared across components

Because a card's status uses the same Status enum as Timeline, Decision, and Release, a single query — "everything in-progress" — works across the whole KB, not just this board.

On this page

Built withsuperlore