Server definition
- Hash
- sha256:fbaaccdfb2dd762f601c84b8297bf589309ecd1c3dc3c9418c4303cb33389112
- What it is
- What a remote MCP server returned when asked what it offers: 196 tools
The blob, as servednamed by its sha256
{
"instructions": "Stable Baseline is a fully headless, agentic workspace for documentation, diagramming, whiteboarding, planning, and shared knowledge. You can drive ALL of it end to end by calling tools, with no human UI, at any level (organisation, workspace, project, folder, document, or board) for any use case.\n\nCapabilities:\n- DOCUMENTS: author and edit living rich-text docs in CDMD markdown (createDocument, editDocument, getDocument, findAndReplaceTextInDocument) and embed diagrams/images inline. See getCdmdLanguageGuide.\n- DIAGRAMS: generate pixel-perfect diagrams from DSL across many families (the platform default renderer, type 'default', for architecture, process, org chart and other box-and-line diagrams; Mermaid, PlantUML, D2, GraphViz, BPMN 2.0, ELK architecture, sequence/state/ERD/Gantt, plus AntV infographics) and get the render back as PNG, JPEG, or SVG (renderDiagram from raw DSL; getDiagramImage for one already in a doc; insertDiagramInDocument to author + embed). Renders are pixel-identical to the editor. See listDiagramTypes (it names each diagram family's default renderer) and getDiagramTypeGuide (for 'default' it lists every property the renderer draws).\n- WHITEBOARDS: author freeform Excalidraw boards from high-level specs (createWhiteboard + addWhiteboardElements: stencils, architecture icons, sticky notes, embedded diagrams, freedraw), or hand a goal to the premium multi-agent designer (autoDesignWhiteboard). Render any board to an image with getWhiteboardImage. See getWhiteboardGuide.\n- PLANS + TASKS: structured plans, phases, tasks, dependencies, and assignees (createPlan, createPlanPhase, createTask, createTaskDependency, updateTask).\n- RISKS + IMPROVEMENTS: log and track improvements, risks, and follow-ups with categories, comments, and evidence (createImprovement, updateImprovement, addImprovementActivity).\n- KNOWLEDGE GRAPH: every document, diagram, plan, and board feeds a self-learning company brain shared across the whole workspace. Retrieve with kg_search (semantic), kg_get_entity, kg_get_wiki_page, kg_related_documents.\nUse searchTools to find the right tool for a task, and listProjects / getProjectHierarchy to orient.\n\nWhiteboard authoring: prefer the RICHEST representation that fits, NOT plain rectangles. Priority: stencil → architecture icon → code/BPMN diagram → plain shapes → image.\n- Sticky/post-it notes → the first-class note: addWhiteboardElements({type:'sticky', text, backgroundColor}) — NOT a stencil (there is no sticky-note stencil). OMIT x/y when adding to an existing board and the note is auto-placed in clear space below the current content (a guessed x/y usually lands on top of existing shapes); set x/y only for deliberate layout.\n- Wireframes/mockups, kanban/scrum, UML/ER, BPMN, org charts, charts, people → a LIBRARY STENCIL. A stencil is a mini-whiteboard (element collection); listWhiteboardStencils returns each one's 'kind' + embedded 'labels' (its real contents). A SYMBOL (flowchart box, BPMN task, org node) takes id + text + width/height and connects via arrow start/end {id}; a TEMPLATE (Alerts, Forms, Tables, Charts) is placed WHOLE, then you customise its returned 'children' by id (retext/recolour/delete). Some symbols are text-less FRAMES (e.g. a UML class box): place create-only, then add text into their regions using the returned 'children' + 'groupId'. Build one stencil then duplicateWhiteboardElements({groupId, dx}) to stamp consistent copies. Place via addWhiteboardElements({type:'stencil', stencil:'<name e.g. decision>', ...}) or an exact stencilKey.\n- Cloud/software-architecture (AWS/Azure/GCP/Docker/Kubernetes/databases) → listArchitectureIcons, then addWhiteboardElements({type:'image', iconPath, x, y}).\n- Real diagrams (default/mermaid/d2/plantuml/graphviz/BPMN) → insertWhiteboardDiagram.\n- Reserve raw rectangles/ellipses for when nothing standard fits.\nCall getWhiteboardGuide before authoring a non-trivial board.",
"tools": [
{
"description": "Per-item: apply a successor's `suggested_start_date`/`suggested_end_date` to its real dates and clear `needs_dependency_review`. For a whole-plan cascade use `applyTaskDependencyCascade`.",
"inputSchema": {
"properties": {
"improvementId": {
"description": "The successor item whose suggestion to apply.",
"type": "string"
}
},
"required": [
"improvementId"
],
"type": "object"
},
"name": "acceptTaskDependencyReview",
"outputSchema": {
"properties": {
"applied": {
"description": "True when the apply call has been atomically committed.",
"type": "boolean"
},
"ok": {
"type": "boolean"
}
},
"type": "object"
}
},
{
"description": "Add a comment or activity entry to an improvement.",
"inputSchema": {
"properties": {
"activityType": {
"description": "Type: comment, agent_update, field_change. Default: comment.",
"type": "string"
},
"comment": {
"description": "Comment text.",
"type": "string"
},
"fieldName": {
"description": "For field_change: field name.",
"type": "string"
},
"improvementId": {
"type": "string"
},
"metadata": {
"description": "Additional context.",
"type": "object"
},
"newValue": {
"description": "For field_change: new value.",
"type": "string"
},
"oldValue": {
"description": "For field_change: previous value.",
"type": "string"
},
"projectId": {
"description": "Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID.",
"type": "string"
}
},
"required": [
"improvementId"
],
"type": "object"
},
"name": "addImprovementActivity",
"outputSchema": {
"properties": {
"activity": {
"type": "object"
}
},
"type": "object"
}
},
{
"description": "Add evidence to an improvement. Types: document_section, diagram_node, incident_note, feedback, free_text.",
"inputSchema": {
"properties": {
"evidenceType": {
"description": "Evidence type. Default: free_text.",
"type": "string"
},
"improvementId": {
"type": "string"
},
"position": {
"description": "Order in evidence list.",
"type": "number"
},
"projectId": {
"description": "Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID.",
"type": "string"
},
"rawContent": {
"description": "Full original text.",
"type": "string"
},
"refId": {
"description": "Reference ID (document, diagram, etc.).",
"type": "string"
},
"refUrl": {
"description": "Reference URL.",
"type": "string"
},
"summary": {
"description": "Summary of the evidence.",
"type": "string"
}
},
"required": [
"improvementId",
"summary"
],
"type": "object"
},
"name": "addImprovementEvidence",
"outputSchema": {
"properties": {
"evidence": {
"type": "object"
}
},
"type": "object"
}
},
{
"description": "Add a comment or activity entry to a plan.",
"inputSchema": {
"properties": {
"activityType": {
"description": "Type: comment, agent_update, field_change. Default: comment.",
"type": "string"
},
"comment": {
"description": "Comment text.",
"type": "string"
},
"fieldName": {
"description": "For field_change: field name.",
"type": "string"
},
"metadata": {
"description": "Additional context.",
"type": "object"
},
"newValue": {
"description": "For field_change: new value.",
"type": "string"
},
"oldValue": {
"description": "For field_change: previous value.",
"type": "string"
},
"planId": {
"type": "string"
},
"projectId": {
"description": "Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID.",
"type": "string"
}
},
"required": [
"planId"
],
"type": "object"
},
"name": "addPlanActivity",
"outputSchema": {
"properties": {
"activity": {
"type": "object"
}
},
"type": "object"
}
},
{
"description": "Add a user to a team as a regular member. Idempotent — returns already_member=true if already on the team. User must be an active organisation member.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"team_id": {
"type": "string"
},
"user_id": {
"type": "string"
}
},
"required": [
"team_id",
"user_id"
],
"type": "object"
},
"name": "addTeamMember",
"outputSchema": {
"properties": {
"team": {
"type": "object"
}
},
"type": "object"
}
},
{
"description": "Author shapes onto a whiteboard from high-level specs (you do NOT need the full Excalidraw element schema). Appends to the canvas. PLACEMENT ON AN EXISTING BOARD (critical): NEVER guess x/y onto a board that already has content — guessed coordinates land ON TOP of existing shapes and create an unreadable pile. Either (a) OMIT x/y entirely and the server auto-places the new elements together in clear space BELOW the current content, or (b) FIRST call getWhiteboard({ includeElements:true }) to see where existing shapes already are and choose a genuinely EMPTY region. Pass explicit x/y only for a deliberate layout in space you have confirmed is empty. PREFER THE RICHEST FORM THAT FITS, not plain rectangles: for a sticky/post-it note use { type:'sticky', text, backgroundColor } (a first-class note with an auto-fitting bound label — there is NO sticky-note stencil; OMIT x/y and it is auto-placed in clear space below existing content, so it doesn't land on top of the current drawing); for kanban/scrum/story boards, flowcharts, UML/ER, BPMN, org charts, wireframes/mockups, charts or people use a LIBRARY STENCIL in ONE call — { type:'stencil', stencil:'<name e.g. decision>', x, y } fuzzy-matches by name with no prior listWhiteboardStencils call (pass width/height to SCALE the whole stencil and text to fill its single label); for cloud/software-architecture use ICONS — { type:'image', iconPath:'dev/docker.svg', x, y } (paths from listArchitectureIcons); reserve raw rectangles/ellipses for when no standard form fits. Expressive enough to reproduce real Excalidraw templates (sticky-note brainstorm grids, sketchy mind maps, flowcharts). Each spec: { type: 'rectangle'|'ellipse'|'diamond'|'sticky'|'text'|'arrow'|'line'|'freedraw'|'frame'|'image'|'stencil', id?, x, y, width, height, text? (STRONGLY PREFER setting a shape's label via its own `text` — it becomes a centered, auto-WRAPPED bound label fitted to the shape; do NOT drop a separate type:'text' element on top of a shape as its label. Standalone type:'text' is for free-floating titles/notes and now also wraps to its width; Yes/No label on an arrow — emojis are fine, e.g. a warning sign in a 'Risks' label), fontSize?, fontFamily? (1=hand-drawn default, 2=normal, 3=code), textAlign?, backgroundColor? (name 'blue'/'green'/'yellow'/'pink'/'violet'/'orange'/'teal'/… or hex), strokeColor?, fillStyle? ('solid'|'hachure'|'cross-hatch'), strokeStyle? ('solid'|'dashed'|'dotted' — use 'dashed' for grid/category borders), strokeWidth? (1 thin/2 bold/4 extra), roughness? (0 clean, 1 default, 2 very sketchy/hand-drawn — use 2 for organic mind maps), roundness? (number type or null for sharp), opacity?, name? (frame title), frameId? (put a shape inside a frame), start?:{id}, end?:{id} (connect arrows/lines to shapes by id — connectors AUTO-CLIP to the shape edges, never overrun to the centre, AUTO-ROUTE around any shapes in between so a decision's No/loop-back branch never cuts straight through the boxes between source and target, and bound text auto-wraps + centres), routing? ('straight' default | 'elbow' for clean right-angle flowchart/org-chart connectors | 'curved'), startArrowhead?/endArrowhead? (arrowheads are SOLID filled triangles by default — just OMIT them. Pass null for a plain mind-map spoke with no head. Do NOT pass 'arrow': that is Excalidraw's open 'V' and is auto-upgraded to a solid triangle anyway), points? ([[0,0],[dx,dy]] relative, only for manual geometry — almost never needed; binding by id is better), props? (escape hatch: any other Excalidraw field) }. ARCHITECTURE ICONS: to place a software-architecture icon (AWS/Azure/GCP/Docker/Kubernetes/databases/etc.), first call listArchitectureIcons to find one, then add a spec { type:'image', iconPath:'<relative_url e.g. dev/docker.svg>', x, y, width:96, height:96, text?:'<caption shown below>' } — the icon is stored as a URL reference (never base64). Use imageUrl instead of iconPath for any other public image. Combine icons with labelled boxes + elbow arrows for clean architecture diagrams. LIBRARY STENCILS: for hand-drawn, on-brand elements (scrum/kanban columns, flowchart symbols, UML/ER, BPMN, org-chart nodes, wireframe widgets, stick figures), FIRST call listWhiteboardStencils to find one, then add { type:'stencil', stencilKey:'<key from listWhiteboardStencils>', x, y } (or { type:'stencil', stencil:'<name e.g. decision>', pack?:'<pack>', x, y } to fuzzy-match by name). A stencil is a mini-whiteboard (a collection of elements) of kind 'symbol' or 'template' (listWhiteboardStencils returns the kind + its embedded `labels`). For a SYMBOL (one atomic labelled node — flowchart box, BPMN task, org node), pass id + text + width/height: the label auto-fits its single slot and arrows bind to it via start/end {id}. For a TEMPLATE (a multi-component layout — Alerts, Forms, Tables, Charts), place it WHOLE (no single text); the result returns its `children` (id + text + colour + position) so you retext, recolour, or DELETE specific parts by id via updateWhiteboardScene (cluster children by y to act on a whole row/variant). STRONGLY prefer stencils over plain rectangles for wireframes/mockups, kanban/scrum boards, UML/BPMN, org charts; for dense flowcharts, plain shapes with bound text + elbow arrows are equally reliable. (For a plain sticky/post-it note use type:'sticky', NOT a stencil — there is no sticky-note stencil.) FRAMES: a frame is a NON-DESTRUCTIVE, ANY-SIZE container. To enclose shapes that ALREADY exist, add ONE type:'frame' sized to cover them (Excalidraw auto-captures elements inside a frame's bounds) or set those shapes' frameId — never recreate or delete-and-redraw content just to frame it. If a frame doesn't fully cover its content, just RESIZE the frame (patch its width/height). Deleting a frame (deleteIds:[frameId]) leaves all its contents intact on the canvas — it only removes the frame border + title. PRESENTATION/SLIDES: when the user wants a presentation or slide deck, create type:'frame' slides sized width:1280,height:720 (16:9), laid out LEFT-TO-RIGHT at the same y (x: 0, then 1440, 2880, 4320, …), each with a `name` (the slide title). Put every slide's shapes/text/images INSIDE its frame by setting their frameId to that frame's id (give the frame an id and reference it). Slides play in order (left-to-right, then top-to-bottom) in the board's Present mode and export to PPTX, so one frame = one slide. FLOWCHART recipe: rectangles (roundness null for sharp process boxes), diamonds for decisions, arrows with routing:'elbow' and Yes/No as the arrow's text. Use type 'sticky' for sticky/post-it notes (a solid-fill note with an auto-fitting bound label — set text + backgroundColor); type 'line' with no arrowheads + roughness:2 for sketchy mind-map spokes. FREEHAND DOODLES: to actually draw/doodle/sketch freehand, use { type:'freedraw', points } where points is a RELATIVE [[x,y],…] path of the stroke (e.g. a squiggle, circling or annotating something, a hand-drawn star/heart/smiley/arrow, an organic blob) — it renders as one smooth freehand stroke. x/y is the origin; omit x/y to auto-place. Chain several freedraw specs for a multi-stroke doodle. NOTE: freehand is always SOLID (Excalidraw ignores strokeStyle on freedraw) — colour, strokeWidth and opacity DO apply; a freedraw with strokeStyle:'dashed' or 'dotted' is automatically rendered as a smooth dashed/dotted line so the dashes actually show. Give shapes ids and reference them from connectors. Connectors may also bind to shapes ALREADY on the board by their id (get them via getWhiteboard includeElements:true) — you do NOT need to resend existing shapes; the server reads the live scene to bind the arrow and route it around the other boxes. Great for brainstorms, mind maps, flowcharts, org charts, SWOT, retros. PROCESS: for any non-trivial board call getWhiteboardGuide FIRST to plan it; then after adding, ALWAYS call getWhiteboardImage to SEE the result and check layout, labels, spacing, overlaps and how shapes connect — if anything looks off, fix it with updateWhiteboardScene (patch by id) and render again, iterating until it looks right. RESULT: returns `added` (count), `placement` (bounding box {x,y,width,height} of what you just added) and `autoPlaced` (true when you omitted x/y so it was placed in clear space below existing content) — use placement/autoPlaced to tell the user WHERE the new elements landed, never invent a location.",
"inputSchema": {
"properties": {
"documentId": {
"type": "string"
},
"projectId": {
"description": "Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID.",
"type": "string"
},
"rerouteConnectors": {
"description": "Optional. Arrows and lines bound to a shape at BOTH ends (start.id and end.id) are always routed around the other shapes on the board unless you give them points. true: ignore the points you gave for such connectors and route them too. Omit to keep the points you supply.",
"type": "boolean"
},
"shapes": {
"description": "Non-empty array of shape specs to append. Prefer stencils / sticky notes / architecture icons over raw rectangles wherever a standard form fits (see the `type` enum below and the tool description).",
"items": {
"additionalProperties": true,
"properties": {
"backgroundColor": {
"description": "Fill colour: a name ('blue'/'green'/'yellow'/'pink'/'violet'/'orange'/'teal'/…) or a hex value.",
"type": "string"
},
"categories": {
"description": "For type:'chart' — x-axis category labels, e.g. ['Jan','Feb','Mar','Apr'].",
"items": {
"type": "string"
},
"type": "array"
},
"chartType": {
"description": "For type:'chart' — the chart family. column=vertical bars (default), bar=horizontal bars, line/area=trends, pie/donut=parts-of-whole, scatter=points, sparkline=tiny inline trend (no axes/legend), combo=bars+line (dual axis via a series with axis:'right'), stackedColumn/groupedColumn=multi-series, radar, gauge.",
"enum": [
"column",
"bar",
"line",
"area",
"pie",
"donut",
"scatter",
"sparkline",
"combo",
"stackedColumn",
"groupedColumn",
"radar",
"gauge"
],
"type": "string"
},
"columns": {
"description": "For type:'table' — column headers: string[] (e.g. ['Task','Owner','Status']) or [{ header:string, width?:number, align?:'left'|'center'|'right' }].",
"items": {
"oneOf": [
{
"type": "string"
},
{
"type": "object"
}
]
},
"type": "array"
},
"customData": {
"additionalProperties": true,
"description": "Arbitrary Excalidraw customData stored on the element (e.g. a slide frame's { deckId } so a board frame resolves back to its source deck). Merged with any builder-set customData.",
"type": "object"
},
"doodle": {
"description": "For type:'doodle' — a named hand-drawn accent rendered as a freehand stroke (no points needed): 'underline' | 'wave' | 'arrow' | 'check' | 'bolt' | 'scribble' | 'star' | 'sparkle' | 'circle' (a ring to encircle/emphasise) | 'heart'. Size it with x/y + width/height and colour it with strokeColor. Great for sketchy emphasis (underline a title, circle a stat, a star/sparkle accent).",
"type": "string"
},
"end": {
"description": "For arrows/lines: { id } of the target shape.",
"type": "object"
},
"fitText": {
"description": "Auto-shrink the bound label's font size so the text always fits inside the shape — no overflow (default true). Set false to keep your exact fontSize even if it spills.",
"type": "boolean"
},
"fontFamily": {
"description": "Font style: 'hand-drawn' (sketchy Excalidraw look, the default), 'sans' (clean/professional — use for business, dashboards, formal diagrams), or 'code' (monospace). Pass this to control the look instead of leaving everything hand-drawn.",
"type": "string"
},
"fontSize": {
"description": "Text size in px. Establish HIERARCHY: titles ~28-40, section headings ~22-28, body/labels ~16-20. Applies to a standalone text, a shape's bound label, a sticky, or an icon caption. Bound labels still auto-shrink to fit unless fitText:false.",
"type": "number"
},
"groupId": {
"description": "Join an existing group. Pass a placed stencil's `groupId` (returned in the placement result) on a type:'text' or shape spec to FILL that frame as part of the same unit — the text then moves, duplicates and renders together with the frame (e.g. a title in a UML class box's top band, members in its body).",
"type": "string"
},
"height": {
"description": "Shape height; for type:'stencil' it scales the whole stencil to fit this height.",
"type": "number"
},
"iconPath": {
"description": "For type:'image' — a software-architecture icon path from listArchitectureIcons (e.g. 'dev/docker.svg').",
"type": "string"
},
"id": {
"description": "Optional id so connectors (arrows/lines) can reference this shape via start/end. On a type:'stencil' it adds a transparent bindable anchor covering the stencil, so an arrow's start/end {id} connects to the whole stencil as a unit.",
"type": "string"
},
"imageUrl": {
"description": "For type:'image' — any other public image URL (use iconPath for curated architecture icons).",
"type": "string"
},
"options": {
"additionalProperties": true,
"description": "For type:'chart' — { legend?:boolean|'top'|'bottom'|'right', gridlines?:boolean|'x'|'y'|'both'|'none', dataLabels?:boolean, yAxis?:boolean, xAxis?:boolean, yMin?:number, yMax?:number, smooth?:boolean, valueFormat?:'%'|'$'|'k', palette?:string[] (hex), donutHole?:number }. For type:'table' — { headerFill?:string (hex), headerTextColor?:string, zebra?:boolean, rowFill?:string, altRowFill?:string, columnColors?:string[] (per-column hex), fontSize?:number, headerFontSize?:number, borderColor?:string, align?:'left'|'center'|'right' }.",
"type": "object"
},
"pack": {
"description": "For type:'stencil' — optional pack to disambiguate a fuzzy `stencil` match (e.g. 'Flowchart', 'BPMN', 'UML & ER', 'Scrum Board').",
"type": "string"
},
"rows": {
"description": "For type:'table' — data rows; each row is an array of cell values (string|number) aligned to columns, e.g. [['T-1','Sam','Done'],['T-2','Lee','WIP']].",
"items": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"type": "array"
},
"type": "array"
},
"scale": {
"description": "For type:'stencil' — uniform scale factor for the whole stencil (alternative to width/height).",
"type": "number"
},
"series": {
"description": "For type:'chart' — one or more data series. Each: { name:string, data:number[], type?:'bar'|'line'|'area' (per-series, for combo), color?:string (hex), axis?:'left'|'right' (dual axis), markers?:boolean (line point markers) }. For pie/donut use ONE series whose data maps to categories.",
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
"start": {
"description": "For arrows/lines: { id } of the source shape (auto-clips to the edge + auto-routes around shapes in between).",
"type": "object"
},
"stencil": {
"description": "For type:'stencil' — fuzzy-match a library stencil by name in ONE call, no prior listWhiteboardStencils needed (e.g. 'decision', 'actor', 'phone frame', 'kanban column'). NOTE: there is no sticky-note stencil — use type:'sticky' for sticky/post-it notes.",
"type": "string"
},
"stencilKey": {
"description": "For type:'stencil' — exact stencil key from listWhiteboardStencils (takes precedence over `stencil`).",
"type": "string"
},
"strokeColor": {
"description": "TEXT colour (for text/labels) or line/border colour (for shapes, arrows, lines, doodles): a name ('blue'/'green'/'red'/'orange'/'violet'/'teal'/…) or a hex value. Use a brand or theme colour for titles/emphasis; default is near-black.",
"type": "string"
},
"text": {
"description": "Label/caption. To label a shape, set `text` on the SHAPE itself — it becomes a BOUND label that the server word-wraps with real font metrics, auto-fits, and positions (centred by default) INSIDE the shape. Never drop a separate type:'text' element on top of a shape, and never hand-compute a label's x/y/width — the server does the geometry (like the editor does when you type into a shape). On a type:'sticky' it's the note text; on a type:'stencil' of kind 'symbol' it fills + re-fits its single label (IGNORED for 'template' stencils — customise their children by id instead). Use a standalone type:'text' only for free-floating text that belongs to no shape.",
"type": "string"
},
"textAlign": {
"description": "Horizontal alignment of the text within its box — the equivalent of the toolbar's align buttons. Bound labels default to 'center'.",
"enum": [
"left",
"center",
"right"
],
"type": "string"
},
"title": {
"description": "For type:'chart' — the chart's title, drawn at the top of the chart.",
"type": "string"
},
"type": {
"description": "Element kind. 'sticky' = a first-class sticky/post-it note (solid fill + auto-fitting bound label; set text + backgroundColor) — use this for sticky notes, NOT a stencil. 'stencil' = a hand-drawn library graphic from listWhiteboardStencils, of kind 'symbol' (one atomic labelled node — flowchart box, BPMN task, org node: set `id` + `text` + width/height, text auto-fits, connect arrows via start/end {id}) or 'template' (a multi-element layout — Alerts, Forms, Tables, Charts: place whole, then customise its returned children by id; do NOT set a single `text`). Set `stencil` (fuzzy name, one call) or `stencilKey` (exact). 'image' with `iconPath` = a software-architecture icon from listArchitectureIcons. 'chart' = a NATIVE, fully-editable data chart (column/bar/line/area/pie/donut/scatter/sparkline/combo/stackedColumn/groupedColumn/radar/gauge) built from real Excalidraw shapes — bars/lines/wedges plus axes, gridlines and a legend — for ANY data, metric, KPI, trend, comparison or breakdown: set chartType + series (+ categories + options). ALWAYS prefer a 'chart' over hand-drawing bars/lines or a wireframe 'chart' stencil. 'table' = a NATIVE, fully-editable GRID (real rectangles + bound, word-wrapped cells, auto-sized columns + rows, a header band, optional zebra striping / per-column colours) for ANY tabular data, list or matrix — set columns + rows (+ options). ALWAYS prefer a 'table' over hand-drawing a grid of boxes. Reserve rectangle/ellipse/diamond for when no standard form fits.",
"enum": [
"rectangle",
"ellipse",
"diamond",
"sticky",
"text",
"arrow",
"line",
"freedraw",
"doodle",
"frame",
"image",
"stencil",
"chart",
"table"
],
"type": "string"
},
"verticalAlign": {
"description": "Vertical alignment of a bound label inside its shape (toolbar parity). Defaults to 'middle' (centred).",
"enum": [
"top",
"middle",
"bottom"
],
"type": "string"
},
"width": {
"description": "Shape width; for type:'stencil' it scales the whole stencil to fit this width.",
"type": "number"
},
"x": {
"description": "Top-left x on the canvas. OMIT both x and y to auto-place this element in clear empty space below the board's existing content. Strongly preferred when adding a note/shape to a board that already has content: a guessed coordinate usually lands ON TOP of existing shapes (the 'added a sticky but can't see it' bug). Set x/y only for deliberate layout among shapes you add in this same call.",
"type": "number"
},
"y": {
"description": "Top-left y on the canvas. Omit together with x to auto-place (see x).",
"type": "number"
}
},
"type": "object"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"documentId",
"shapes"
],
"type": "object"
},
"name": "addWhiteboardElements",
"outputSchema": {
"type": "object"
}
},
{
"description": "Add an existing organisation member to a workspace with a workspace-level role. Idempotent — returns the existing membership if already a member. Caller must be a workspace owner or admin.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"user_id": {
"description": "Must already be an active organisation member.",
"type": "string"
},
"workspace_id": {
"type": "string"
},
"workspace_role": {
"enum": [
"owner",
"admin",
"editor",
"viewer"
],
"type": "string"
}
},
"required": [
"workspace_id",
"user_id",
"workspace_role"
],
"type": "object"
},
"name": "addWorkspaceMember",
"outputSchema": {
"properties": {
"member": {
"type": "object"
}
},
"type": "object"
}
},
{
"description": "Apply a previously previewed KG scope change. Atomically writes kg_scope rows and dispatches a re-ingest batch (batch_id = token). Idempotent. Rate limit 5/h.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"confirmation_token": {
"type": "string"
}
},
"required": [
"confirmation_token"
],
"type": "object"
},
"name": "applyKgScopeChange",
"outputSchema": {
"properties": {
"applied": {
"description": "True when the apply call has been atomically committed.",
"type": "boolean"
},
"ok": {
"type": "boolean"
}
},
"type": "object"
}
},
{
"description": "Apply a previously previewed subscription change. Same-tier seat changes update Stripe in place; cross-tier upgrades from Free return a hosted Checkout URL. Refuses target=free (use cancelSubscription) and target=enterprise (sales-led). Rate limit 5/h. Use only AFTER previewSubscriptionChange and after the user confirms the preview's pricing — never call apply without the user seeing the preview first.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"confirmation_token": {
"type": "string"
}
},
"required": [
"confirmation_token"
],
"type": "object"
},
"name": "applySubscriptionChange",
"outputSchema": {
"properties": {
"applied": {
"description": "True when the apply call has been atomically committed.",
"type": "boolean"
},
"ok": {
"type": "boolean"
}
},
"type": "object"
}
},
{
"description": "Auto-schedule every item in a plan so all FS/SS/FF task-dependencies are respected (topological pass, durations preserved). Returns the before/after diff and logs a comment on every item that moves. Use `forwardOnly: true` to only shift items currently in violation (never pull already-valid items earlier). Use `pinnedItemIds` to keep specific items at their current dates. Pairs with `previewTaskDependencyCascade` (same inputs, dry-run).",
"inputSchema": {
"properties": {
"forwardOnly": {
"description": "When true, only shift items currently in violation — never pull already-valid items to an earlier slot. Default false for backwards compat with the manual Auto-schedule button.",
"type": "boolean"
},
"pinnedItemIds": {
"description": "Item IDs to keep at their current dates (typical: the item you just updated).",
"items": {
"type": "string"
},
"type": "array"
},
"planId": {
"description": "Plan to reschedule.",
"type": "string"
}
},
"required": [
"planId"
],
"type": "object"
},
"name": "applyTaskDependencyCascade",
"outputSchema": {
"properties": {
"applied": {
"description": "True when the apply call has been atomically committed.",
"type": "boolean"
},
"ok": {
"type": "boolean"
}
},
"type": "object"
}
},
{
"description": "Auto-design a complete, visually polished whiteboard from a natural-language goal using the PREMIUM multi-agent pipeline (the same one the in-app assistant uses): it browses the stencil/icon library, composes the WHOLE board, renders it, critiques the rendered image, and refines — far better than hand-placing shapes. This is the one-shot whole-board designer; it is NOT a conversation (for a deck you can chat with and refine turn by turn use designDeckInWhiteboard, and for a refinable illustration use designIllustrationInWhiteboard). COST + APPROVAL: this costs 50 credits per board and requires the user's explicit approval. Call it FIRST without `confirm` to get the exact cost + the workspace credit balance; show that to the user and only call again with `confirm: true` once they agree. If they decline (or lack credits), build the board directly with the standard whiteboard tools (addWhiteboardElements / insertWhiteboardDiagram / listWhiteboardStencils) at no extra charge. It runs in the BACKGROUND and returns immediately with a sessionId; the board fills in over 1-3 minutes. The 50 credits are refunded automatically if the design fails on our side. Optional `designProfile: 'branded-executive'` instead builds an ON-BRAND, fully-editable McKinsey-style SLIDE DECK themed by the org's brand kit (palette/fonts) — use it when the user wants polished branded business slides; it builds in-process and the board is ready on return. Optional `designProfile: 'illustrated'` instead builds an editable-illustration board: pick it for illustrated, image-based, picture-style, richly-drawn or educational explainer boards (e.g. illustrate photosynthesis, an illustrated diagram of the water cycle, a textbook-style visual). It generates a rich text-free vector illustration and overlays real, editable text labels with leader lines on top. It is available to every organisation and costs the same flat 50 credits (credits are the only gate). Optional `designProfile: 'image'` instead builds a single, polished, on-brand IMAGE board with all the text baked into the picture (no editable shapes): pick 'image' when the user wants a single finished image, poster or infographic they will refine by AI mask edits rather than by moving editable shapes. It is also available to every organisation at the same flat 50 credits.",
"inputSchema": {
"properties": {
"brandKitId": {
"description": "Optional brand kit id (from listBrandKits) to theme a branded-executive deck. If omitted, the org's built-in default is used. Create one from just a logo (or a .pptx/.docx) via createBrandKit.",
"type": "string"
},
"confirm": {
"description": "Set true ONLY after the user has approved the 50-credit cost. Leave unset/false on the first call to receive the cost quote + balance.",
"type": "boolean"
},
"designProfile": {
"description": "Optional. 'standard' (default) = the general multi-agent design. 'agentic' = an AI-chat-style agentic slide composer that drives the whiteboard tools and self-corrects from renders, composing ONE polished slide. 'agentic-deck' = the same agentic composer run over a planned storyline, building a multi-slide deck (each slide on its own frame, tiled left to right). 'branded-executive' = an on-brand, McKinsey-style editable SLIDE DECK themed by the org's brand kit (pair with brandKitId, or omit for the org default). 'illustrated' = an editable-illustration board: a rich text-free vector illustration with real editable text labels and leader lines placed on top. 'image' = a single polished, on-brand IMAGE board with all the text baked into the picture (no editable shapes), which the user then refines with AI mask edits. Every profile is available to every organisation; the flat credit fee is the only gate.",
"enum": [
"standard",
"branded-executive",
"illustrated",
"image",
"agentic",
"agentic-deck"
],
"type": "string"
},
"documentId": {
"description": "Optional. An existing whiteboard to design into. If omitted, a new whiteboard is created in projectId.",
"type": "string"
},
"goal": {
"description": "The board to build, in plain language.",
"type": "string"
},
"projectId": {
"description": "The project to create the whiteboard in, when no documentId is given.",
"type": "string"
},
"sourceTranscript": {
"description": "Design the board from a meeting transcript (exactly one of documentId or text). When set, the board is built as a 'meeting map' (topics, decisions, actions) from the transcript instead of from the goal alone. This mode is billed by transcript LENGTH — 2 credits per minute of transcript (10-minute minimum), not the flat 50; the first (unconfirmed) call returns the exact cost to relay to the user.",
"properties": {
"documentId": {
"description": "The id of a Stable Baseline document holding the meeting transcript/notes to design from.",
"type": "string"
},
"text": {
"description": "The raw transcript text to design from (pasted). Provide this OR documentId, not both.",
"type": "string"
}
},
"type": "object"
},
"title": {
"description": "Optional board title. If omitted, a clear title is derived from the goal (the board is never left 'Untitled'). When designing into an existing 'Untitled' board, the derived/explicit title replaces the placeholder.",
"type": "string"
}
},
"required": [
"goal"
],
"type": "object"
},
"name": "autoDesignWhiteboard",
"outputSchema": {
"type": "object"
}
},
{
"description": "Emergency stop for KG ingestion: cancels queued/running build runs, queued/running rebuild batches, demotes still-eager unfinished chunks. Optionally narrowed to one project. Requires can_manage_kg + (project write if project_id supplied). Rate limit 5/min.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"organisation_id": {
"type": "string"
},
"project_id": {
"type": "string"
}
},
"required": [
"organisation_id"
],
"type": "object"
},
"name": "cancelAllKgInScope",
"outputSchema": {
"properties": {
"cancelled": {
"description": "Counts of cancelled runs / demoted chunks.",
"type": "object"
}
},
"type": "object"
}
},
{
"description": "Cancel a pending invitation by id. Sets status='revoked'. Server resolves the organisation_id from the invitation row; the credential must match that org AND hold can_manage_members. Idempotent. Rate limit 30/min. Use when the user asks to cancel, revoke, or undo a pending invitation — for example to correct a typo'd email address before re-inviting.",
"inputSchema": {
"properties": {
"invitation_id": {
"description": "Invitation UUID. Server resolves the organisation from this row.",
"type": "string"
}
},
"required": [
"invitation_id"
],
"type": "object"
},
"name": "cancelInvitation",
"outputSchema": {
"properties": {
"deleted_id": {
"type": "string"
},
"ok": {
"description": "Alias of success.",
"type": "boolean"
},
"success": {
"description": "True when the deletion completed.",
"type": "boolean"
}
},
"type": "object"
}
},
{
"description": "Cancel a single KG rebuild batch. Queued runs flip to 'cancelled' immediately; running runs finish naturally. Requires can_manage_kg. Rate limit 5/min.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"batch_id": {
"type": "string"
}
},
"required": [
"batch_id"
],
"type": "object"
},
"name": "cancelKgBuildBatch",
"outputSchema": {
"properties": {
"ok": {
"type": "boolean"
}
},
"type": "object"
}
},
{
"description": "Apply a previewed soft cancellation (cancel_at_period_end=true). Customer keeps full access until period end. Rate limit 5/h. Use only AFTER previewSubscriptionCancellation and after the user confirms — never cancel without showing the preview first.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"confirmation_token": {
"type": "string"
}
},
"required": [
"confirmation_token"
],
"type": "object"
},
"name": "cancelSubscription",
"outputSchema": {
"properties": {
"cancellation": {
"type": "object"
}
},
"type": "object"
}
},
{
"description": "Create a per-org BRAND KIT so Stable Baseline outputs come out fully on-brand. Upload your branding and it is auto-applied: pass a `logoUrl` (as little as your logo, and the vision model AUTO-EXTRACTS your palette and fonts), or an `officeUrl` (an existing .pptx/.docx, from which it extracts theme colours, fonts, logo, watermark and the embedded font files), or explicit `tokens`. The kit themes branded-executive slides AND document exports (PDF, Word, PowerPoint). Auth: can_admin_org. Tiered: free 0, pro 1, enterprise unlimited. Optionally set it as the default at a scope in one call.",
"inputSchema": {
"properties": {
"guidance": {
"description": "Optional extra guidance for the extractor (e.g. 'use the teal, not the grey').",
"type": "string"
},
"logoUrl": {
"description": "Image URL of the logo to extract palette/fonts from (PNG/JPG/SVG). Omit if passing officeUrl or tokens.",
"type": "string"
},
"name": {
"description": "Display name (e.g. the brand/company name).",
"type": "string"
},
"officeUrl": {
"description": "URL of an existing .pptx or .docx to extract the brand from (theme colours + fonts + logo + watermark + embedded fonts). Max 25MB. Omit if passing logoUrl or tokens.",
"type": "string"
},
"organizationId": {
"description": "Org that owns the kit.",
"type": "string"
},
"setDefaultScope": {
"description": "Optionally set the new kit as default at this scope.",
"enum": [
"organization",
"workspace",
"project"
],
"type": "string"
},
"setDefaultScopeId": {
"description": "Workspace/project id when setDefaultScope is workspace/project.",
"type": "string"
},
"tokens": {
"additionalProperties": true,
"description": "Explicit DTCG brand tokens { color:{brand:{primary,primaryText,ink,bg,surface,muted,border,positive,warning,negative,accentHover?,accentActive?}}, font:{heading,body} }. EXTENDED CAPTURE (all optional; captured values replace derivation heuristics in deck/document theming): structure:{typeScalePx:[..], leadingBody, leadingTight, trackingDisplayEm, spacingPx:[..], radiusPx:{sm,md,lg}, elevation:'flat'|'ring'|'soft'|'raised'}, motion:{speed:'snappy'|'standard'|'stately', easing:'cubic-bezier(..)'}, voice:{tone, notes}, imagery:{style, notes}, antiPatterns:['never ..']. Omit tokens entirely to extract from logoUrl/officeUrl.",
"type": "object"
}
},
"required": [
"organizationId",
"name"
],
"type": "object"
},
"name": "createBrandKit",
"outputSchema": {
"type": "object"
}
},
{
"description": "Create a document from CDMD markdown (standard Markdown plus SB extensions — call getCdmdLanguageGuide if unfamiliar). The body goes in `cdmd` (`content` is accepted as an alias). A leading `---` YAML frontmatter block is stored and preserved: title/exported_at/generator are managed by the platform, and any other key you set (doc_type, authority_state, owner, conforms_to, …) round-trips untouched through reads and later edits. Do not include DIAGRAM/IMAGE markers — insert them after with dedicated tools. Returns the new document's id and versionTimestamp (the optimistic-lock token for subsequent edits). Supports @-mentioning people: embed `<!-- REFERENCE: {\"type\":\"user\",\"id\":\"<user_uuid>\",\"label\":\"Name\"} -->` to notify a teammate. Use listAssignablePrincipals to look up the user_id from a name; mentions of users outside the project are silently dropped.",
"inputSchema": {
"properties": {
"cdmd": {
"description": "Document body in CDMD markdown. Alias: content.",
"type": "string"
},
"changeSummary": {
"description": "Version history summary.",
"type": "string"
},
"content": {
"description": "Alias for cdmd — provide one of the two.",
"type": "string"
},
"folderId": {
"type": "string"
},
"position": {
"description": "Sort position within the parent folder (or project root if no folderId). When omitted, the document is appended at the end.",
"type": "number"
},
"projectId": {
"type": "string"
},
"title": {
"type": "string"
}
},
"required": [
"projectId"
],
"type": "object"
},
"name": "createDocument",
"outputSchema": {
"properties": {
"document": {
"description": "The document after the mutation.",
"type": "object"
},
"href": {
"description": "Web URL of the resource in the Stable Baseline app.",
"type": "string"
},
"versionTimestamp": {
"description": "Milliseconds since epoch. Pass back as `versionTimestamp` on subsequent edit/update calls for optimistic locking.",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Step 2 of file ingest. After the file is uploaded via the PUT URL from createDocumentIngestSession, call this to start the async conversion. Returns { jobId, documentId } immediately — the document is created as a draft and progressively populated as the worker processes the file. Poll getDocumentIngestJob({ jobId }) to track progress. Idempotent: calling twice with the same sessionId returns the same job/document.",
"inputSchema": {
"properties": {
"changeSummary": {
"description": "Optional changelog message for the version snapshot taken when the ingest finalises.",
"type": "string"
},
"folderId": {
"description": "Optional folder. Must belong to projectId.",
"type": "string"
},
"projectId": {
"description": "Must match the project the session was created for.",
"type": "string"
},
"sessionId": {
"description": "From createDocumentIngestSession.",
"type": "string"
},
"title": {
"description": "Optional document title. Defaults to the upload's filename without extension.",
"type": "string"
}
},
"required": [
"sessionId",
"projectId"
],
"type": "object"
},
"name": "createDocumentFromUpload",
"outputSchema": {
"properties": {
"job_id": {
"type": "string"
},
"status": {
"type": "string"
}
},
"type": "object"
}
},
{
"description": "Step 1 of file ingest. Mint a single-use PUT upload URL for a large file (PDF, DOCX, plain text, or markdown — up to 150 MB). Returns { sessionId, uploadUrl, expiresAt, maxBytes }. Upload the raw bytes to uploadUrl with PUT, then call createDocumentFromUpload({ sessionId, projectId }) to start the conversion. The file is auto-deleted once the document is created.",
"inputSchema": {
"properties": {
"fileName": {
"description": "Original filename, e.g. report.pdf.",
"type": "string"
},
"folderId": {
"description": "Optional folder to drop the document into. Must belong to projectId.",
"type": "string"
},
"mimeType": {
"description": "One of: application/pdf, application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX), text/plain, text/markdown.",
"type": "string"
},
"projectId": {
"description": "Target project for the resulting document.",
"type": "string"
},
"sizeBytes": {
"description": "Optional file size hint in bytes. Rejected up-front if it exceeds 150 MB.",
"type": "number"
}
},
"required": [
"projectId",
"fileName",
"mimeType"
],
"type": "object"
},
"name": "createDocumentIngestSession",
"outputSchema": {
"properties": {
"expires_at": {
"type": "string"
},
"ingest_token": {
"type": "string"
},
"upload_url": {
"type": "string"
}
},
"type": "object"
}
},
{
"description": "Create a folder in a project. Supports nesting via parentId.",
"inputSchema": {
"properties": {
"name": {
"type": "string"
},
"parentId": {
"type": "string"
},
"position": {
"type": "number"
},
"projectId": {
"type": "string"
}
},
"required": [
"projectId",
"name"
],
"type": "object"
},
"name": "createFolder",
"outputSchema": {
"properties": {
"folder": {
"description": "The folder after the mutation.",
"type": "object"
},
"href": {
"description": "Web URL of the resource in the Stable Baseline app.",
"type": "string"
},
"versionTimestamp": {
"description": "Milliseconds since epoch. Pass back as `versionTimestamp` on subsequent edit/update calls for optimistic locking.",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Create a PUT upload URL for a document image (max 10MB). Use the returned assetUrl with insertImageInDocument.",
"inputSchema": {
"properties": {
"documentId": {
"type": "string"
},
"fileName": {
"description": "Original filename (e.g. screenshot.png).",
"type": "string"
},
"mimeType": {
"description": "Image MIME type (e.g. image/png).",
"type": "string"
},
"projectId": {
"description": "Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID.",
"type": "string"
},
"sha256": {
"description": "Optional SHA-256 hex digest.",
"type": "string"
}
},
"required": [
"documentId",
"fileName",
"mimeType"
],
"type": "object"
},
"name": "createImageUploadSession",
"outputSchema": {
"properties": {
"expires_at": {
"type": "string"
},
"object_path": {
"type": "string"
},
"upload_url": {
"type": "string"
}
},
"type": "object"
}
},
{
"description": "Create an improvement item in a project. Requires projectId and title. Auto-assigns friendly ID. Accepts every field updateImprovement accepts, so an item can be created complete in one call rather than create-then-update. Pass parentItemId to create it under its epic or story in the work hierarchy. Pass `fields` (for example [\"id\", \"friendlyId\", \"versionTimestamp\"]) for a short answer instead of the whole improvement.",
"inputSchema": {
"properties": {
"acceptance_criteria": {
"description": "Acceptance criteria — ordered list of pass/fail statements that define \"done\" for this item. Each row is `{ id, text }` with server-stamped `updated_at / updated_by / updated_by_credential_name`. REPLACES the whole array on update. Echo back existing `id`s on rows you keep so attribution stamps survive. Bare strings are accepted for convenience (e.g. `[\"row 1\", \"row 2\"]`) and auto-converted to `{ id, text }`.",
"items": {
"anyOf": [
{
"description": "Shorthand for `{ text: \"...\" }`.",
"type": "string"
},
{
"properties": {
"id": {
"description": "Optional — server mints one if omitted. Preserve on edits.",
"type": "string"
},
"text": {
"type": "string"
},
"updated_at": {
"description": "Server-stamped. Echo back unchanged; ignored on new rows.",
"type": "string"
},
"updated_by": {
"description": "Server-stamped user id. Echo back unchanged.",
"type": "string"
},
"updated_by_credential_name": {
"description": "Server-stamped credential label. Echo back unchanged.",
"type": "string"
}
},
"required": [
"text"
],
"type": "object"
}
]
},
"type": "array"
},
"agent_brief": {
"type": "string"
},
"agent_complexity": {
"description": "low, medium, high, very_high.",
"type": "string"
},
"agent_confidence": {
"description": "0.00 to 1.00.",
"type": "number"
},
"agent_missing_info": {
"items": {
"type": "string"
},
"type": "array"
},
"agent_ready": {
"type": "boolean"
},
"agent_recommended_action": {
"type": "string"
},
"business_impact": {
"type": "string"
},
"category_id": {
"description": "Category ID.",
"type": "string"
},
"checklist": {
"description": "Tick-box checklist shown above acceptance_criteria. The full array REPLACES the stored list on update, and array order = display order — to edit, fetch via getTask/getImprovement, modify, and send back the whole list. Operations: mark done with `completed: true`; un-mark with `completed: false`; add rows by appending `{ text }` (id is auto-minted); remove by omitting; reorder by rearranging. Echo back each existing `id` you keep so per-row attribution (who added/completed it, when) survives.",
"items": {
"properties": {
"completed": {
"description": "true = ticked, false/omitted = not done. Server stamps timestamp + actor.",
"type": "boolean"
},
"completed_at": {
"description": "Server-stamped ISO timestamp. Prefer `completed`; an explicit value here wins if both are sent.",
"type": "string"
},
"completed_by": {
"description": "Server-stamped user id. Echo back unchanged.",
"type": "string"
},
"completed_by_credential_name": {
"description": "Server-stamped credential label. Echo back unchanged.",
"type": "string"
},
"due_date": {
"description": "Optional YYYY-MM-DD; null to clear.",
"type": "string"
},
"id": {
"description": "Optional — server mints one if omitted. Preserve on edits.",
"type": "string"
},
"text": {
"type": "string"
},
"updated_at": {
"description": "Server-stamped. Echo back unchanged; ignored on new rows.",
"type": "string"
},
"updated_by": {
"description": "Server-stamped user id. Echo back unchanged.",
"type": "string"
},
"updated_by_credential_name": {
"description": "Server-stamped credential label. Echo back unchanged.",
"type": "string"
}
},
"required": [
"text"
],
"type": "object"
},
"type": "array"
},
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"desired_outcome": {
"type": "string"
},
"details": {
"description": "The type's own fields. On update they MERGE key by key: keys you leave out are kept and null removes one. epic: success_measures. user_story: as_a, i_want, so_that (read as 'As a <as_a>, I want <i_want>, so that <so_that>') and story_points. requirement: statement ('The system shall...'), requirement_kind, rationale, source, verification_method. test_case: preconditions, test_steps (ordered { action, expected }), test_data, last_result, last_run_on. spike: question, timebox, findings. An item keeps its details when its type changes.",
"properties": {
"as_a": {
"description": "As a (role or persona)",
"maxLength": 500,
"type": [
"string",
"null"
]
},
"findings": {
"description": "Findings (What was learned, and the recommendation...)",
"maxLength": 20000,
"type": [
"string",
"null"
]
},
"i_want": {
"description": "I want (what they want to do)",
"maxLength": 500,
"type": [
"string",
"null"
]
},
"last_result": {
"description": "Last Result",
"enum": [
"not_run",
"passed",
"failed",
"blocked",
null
],
"type": [
"string",
"null"
]
},
"last_run_on": {
"description": "Last Run, YYYY-MM-DD.",
"type": [
"string",
"null"
]
},
"preconditions": {
"description": "Preconditions (What must be true before the test starts...)",
"maxLength": 20000,
"type": [
"string",
"null"
]
},
"question": {
"description": "Question (What does this spike need to find out?)",
"maxLength": 20000,
"type": [
"string",
"null"
]
},
"rationale": {
"description": "Rationale (Why it is needed...)",
"maxLength": 20000,
"type": [
"string",
"null"
]
},
"requirement_kind": {
"description": "Kind",
"enum": [
"functional",
"non_functional",
"interface",
"data",
"business_rule",
"constraint",
"compliance",
null
],
"type": [
"string",
"null"
]
},
"so_that": {
"description": "So that (the benefit to them)",
"maxLength": 500,
"type": [
"string",
"null"
]
},
"source": {
"description": "Source (A stakeholder, regulation or document)",
"maxLength": 500,
"type": [
"string",
"null"
]
},
"statement": {
"description": "Requirement (The system shall...)",
"maxLength": 20000,
"type": [
"string",
"null"
]
},
"story_points": {
"description": "Story Points (e.g. 3)",
"maximum": 1000,
"minimum": 0,
"type": [
"number",
"null"
]
},
"success_measures": {
"description": "Success Measures (How will you know this epic delivered its outcome?)",
"maxLength": 20000,
"type": [
"string",
"null"
]
},
"test_data": {
"description": "Test Data (Inputs, accounts or records the steps use...)",
"maxLength": 20000,
"type": [
"string",
"null"
]
},
"test_steps": {
"description": "Test Steps, in order. The list you send REPLACES the stored one.",
"items": {
"properties": {
"action": {
"description": "What the tester does.",
"maxLength": 4000,
"type": "string"
},
"expected": {
"description": "What should happen.",
"maxLength": 4000,
"type": "string"
},
"id": {
"description": "Optional; minted if omitted. Echo it back on the steps you keep.",
"maxLength": 64,
"type": "string"
}
},
"type": "object"
},
"maxItems": 200,
"type": [
"array",
"null"
]
},
"timebox": {
"description": "Timebox (e.g. 3 days)",
"maxLength": 500,
"type": [
"string",
"null"
]
},
"verification_method": {
"description": "Verified By",
"enum": [
"test",
"inspection",
"analysis",
"demonstration",
null
],
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"end_date": {
"description": "YYYY-MM-DD.",
"type": "string"
},
"fields": {
"description": "Optional. Answer with only these fields instead of the whole improvement, for example [\"id\", \"versionTimestamp\"]. Any of the improvement's own fields (snake_case or camelCase) or of the keys around it in the full answer (versionTimestamp, href and, where present, url, title, trackingId, message). The id is always returned, and so is any notice that needs your attention (a note, such as a phase's dates following its tasks or an item's id changing with its type, and a date change's cascadePreview). Unknown names are ignored.",
"items": {
"maxLength": 64,
"type": "string"
},
"maxItems": 50,
"type": "array"
},
"impacted_components": {
"items": {
"type": "string"
},
"type": "array"
},
"impacted_diagrams": {
"description": "Array of {id, name}.",
"items": {
"type": "object"
},
"type": "array"
},
"impacted_documents": {
"description": "Array of {id, title}.",
"items": {
"type": "object"
},
"type": "array"
},
"impacted_repositories": {
"items": {
"type": "string"
},
"type": "array"
},
"is_task": {
"description": "Mark as task. Default: false. Prefer setting type='task' instead: is_task is kept in sync from the type by a DB trigger, and the friendly id's prefix follows the type too (see type).",
"type": "boolean"
},
"linked_document_ids": {
"description": "Document IDs to link. Titles resolved automatically.",
"items": {
"type": "string"
},
"type": "array"
},
"metadata": {
"description": "Free-form JSON stored alongside the item. On updateImprovement this MERGES rather than replaces.",
"type": "object"
},
"non_goals": {
"items": {
"type": "string"
},
"type": "array"
},
"owner_id": {
"description": "User UUID to assign as the owner. MUTUALLY EXCLUSIVE with owner_team_id — set one or the other, never both. Use listAssignablePrincipals(projectId, kind='user', q='…') to look up valid user UUIDs.",
"type": "string"
},
"owner_team_id": {
"description": "Team UUID to assign as the owner (assigns the whole team rather than an individual). MUTUALLY EXCLUSIVE with owner_id. Use listTeams(workspaceId) or listAssignablePrincipals(projectId, kind='team') to look up valid team UUIDs.",
"type": "string"
},
"parentItemId": {
"description": "The work item this one belongs to in the work hierarchy: an epic for a story, a story for its tasks or test cases. Any item in the same project, in any plan or phase. Not the plan outline nesting, which setPlanItemParent sets. Give its UUID or friendly id (such as IMP-12 or TAS-3). Rules: the same project; no loops (an item cannot sit inside its own children); at most 5 levels, counting this item's own children.",
"maxLength": 64,
"type": "string"
},
"percent_complete": {
"description": "Progress percentage (0-100). Null means not tracked.",
"type": "number"
},
"phase_id": {
"description": "Assign to a phase.",
"type": "string"
},
"plan_id": {
"description": "Link to a plan.",
"type": "string"
},
"priority": {
"description": "Priority. Default: medium.",
"type": "string"
},
"problem_statement": {
"type": "string"
},
"projectId": {
"type": "string"
},
"relationships": {
"description": "Free-form JSON for logical links: blocks, blocked_by, duplicates, supersedes, relates_to (arrays of item IDs).",
"type": "object"
},
"source": {
"description": "Where the work came from. Default: human_manual (shown as a general item), which is right for anything you raise yourself. Use feedback, incident, postmortem, code_review, doc_comment or imported when the item came from one of those. agent_review files the item under Compliance in the register: use it only for a compliance finding.",
"enum": [
"human_manual",
"agent_review",
"doc_comment",
"feedback",
"incident",
"postmortem",
"code_review",
"imported"
],
"type": "string"
},
"source_channel": {
"type": "string"
},
"start_date": {
"description": "YYYY-MM-DD.",
"type": "string"
},
"status": {
"description": "Initial status. Default: captured.",
"enum": [
"captured",
"triaging",
"shaped",
"approved",
"ready_for_agent",
"in_progress",
"ready_for_review",
"in_review",
"blocked",
"done",
"rejected",
"deferred"
],
"type": "string"
},
"target_date": {
"description": "YYYY-MM-DD.",
"type": "string"
},
"title": {
"type": "string"
},
"type": {
"description": "Type. Default: enhancement. One of: feature (New capability for users); enhancement (An improvement to something that already exists); bug (Something that does not work as it should); tech_debt (Work that makes the system easier and safer to change); architecture_gap (A missing or weak part of the architecture); documentation_gap (Documentation that is missing or out of date); risk (Something that could go wrong, to track and reduce); epic (A large body of work, delivered through several stories, features or tasks); user_story (A need told from a user's view: as a role, I want a goal, so that a benefit); requirement (A condition or capability the solution must meet, stated so it can be verified); test_case (Steps that verify a requirement or story, each with its expected result); spike (Time-boxed research to answer a question before committing to the work); task (A unit of work in a plan). Despite the tool's name there is no 'improvement' value: pass it and it is accepted as an alias for 'enhancement', which is also the default. Setting type='task' makes the row a task; any other type makes it a non-task item. The id's prefix follows the type: epic EPIC-, user_story STY-, requirement REQ-, test_case TC-, spike SPK-, task TAS-; every other type IMP-. The number is shared by every type and never changes: a type change rewrites only the prefix (STY-30 becomes IMP-30), and the old id still resolves. Types with fields of their own (epic, user_story, requirement, test_case, spike) take them in details.",
"type": "string"
},
"urgency": {
"description": "e.g. this_week, this_month, this_quarter.",
"type": "string"
},
"user_impact": {
"type": "string"
},
"wbs_code": {
"description": "Work breakdown structure code.",
"type": "string"
},
"why_now": {
"type": "string"
}
},
"required": [
"projectId",
"title"
],
"type": "object"
},
"name": "createImprovement",
"outputSchema": {
"properties": {
"href": {
"description": "Web URL of the resource in the Stable Baseline app.",
"type": "string"
},
"improvement": {
"description": "The improvement after the mutation.",
"type": "object"
},
"versionTimestamp": {
"description": "Milliseconds since epoch. Pass back as `versionTimestamp` on subsequent edit/update calls for optimistic locking.",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Create an improvement category or sub-category. Max two levels.",
"inputSchema": {
"properties": {
"color": {
"description": "Color code.",
"type": "string"
},
"description": {
"type": "string"
},
"icon": {
"description": "Lucide icon name.",
"type": "string"
},
"name": {
"type": "string"
},
"parentId": {
"description": "Parent category ID for sub-categories.",
"type": "string"
},
"projectId": {
"type": "string"
},
"slug": {
"description": "URL-friendly slug. Auto-generated if omitted.",
"type": "string"
},
"sortOrder": {
"description": "Sort order. Default: 0.",
"type": "number"
}
},
"required": [
"projectId",
"name"
],
"type": "object"
},
"name": "createImprovementCategory",
"outputSchema": {
"properties": {
"category": {
"description": "The category after the mutation.",
"type": "object"
},
"href": {
"description": "Web URL of the resource in the Stable Baseline app.",
"type": "string"
},
"versionTimestamp": {
"description": "Milliseconds since epoch. Pass back as `versionTimestamp` on subsequent edit/update calls for optimistic locking.",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Create a new organisation owned by the calling credential's user. Auth: server-side eligibility gate via `can_user_create_organization` (free-tier users may only have one org). Per-credential rate limit 3/day. Slug auto-generated. The new org is OUTSIDE the credential's current scope (credentials are bound to one org); to use the new org from MCP, mint a fresh credential.",
"inputSchema": {
"properties": {
"description": {
"description": "Optional free-text description.",
"maxLength": 2000,
"type": "string"
},
"name": {
"description": "Display name.",
"maxLength": 200,
"minLength": 1,
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"name": "createOrganisation",
"outputSchema": {
"properties": {
"href": {
"description": "Web URL of the resource in the Stable Baseline app.",
"type": "string"
},
"organisation": {
"description": "The organisation after the mutation.",
"type": "object"
},
"versionTimestamp": {
"description": "Milliseconds since epoch. Pass back as `versionTimestamp` on subsequent edit/update calls for optimistic locking.",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Create a plan in a project. Requires projectId and title. Pass `fields` (for example [\"id\", \"versionTimestamp\"]) for a short answer instead of the whole plan.",
"inputSchema": {
"properties": {
"color": {
"description": "Color code.",
"type": "string"
},
"description": {
"type": "string"
},
"end_date": {
"description": "YYYY-MM-DD.",
"type": "string"
},
"fields": {
"description": "Optional. Answer with only these fields instead of the whole plan, for example [\"id\", \"versionTimestamp\"]. Any of the plan's own fields (snake_case or camelCase) or of the keys around it in the full answer (versionTimestamp, href and, where present, url, title, trackingId, message). The id is always returned, and so is any notice that needs your attention (a note, such as a phase's dates following its tasks or an item's id changing with its type, and a date change's cascadePreview). Unknown names are ignored.",
"items": {
"maxLength": 64,
"type": "string"
},
"maxItems": 50,
"type": "array"
},
"icon": {
"description": "Lucide icon name.",
"type": "string"
},
"linked_document_ids": {
"description": "Document IDs to link.",
"items": {
"type": "string"
},
"type": "array"
},
"linked_documents": {
"description": "Array of {id, title}.",
"items": {
"type": "object"
},
"type": "array"
},
"priority": {
"description": "Priority. Default: medium.",
"type": "string"
},
"projectId": {
"type": "string"
},
"start_date": {
"description": "YYYY-MM-DD.",
"type": "string"
},
"status": {
"description": "Status. Default: draft.",
"enum": [
"draft",
"planning",
"active",
"on_hold",
"completed",
"cancelled"
],
"type": "string"
},
"title": {
"type": "string"
}
},
"required": [
"projectId",
"title"
],
"type": "object"
},
"name": "createPlan",
"outputSchema": {
"properties": {
"href": {
"description": "Web URL of the resource in the Stable Baseline app.",
"type": "string"
},
"plan": {
"description": "The plan after the mutation.",
"type": "object"
},
"versionTimestamp": {
"description": "Milliseconds since epoch. Pass back as `versionTimestamp` on subsequent edit/update calls for optimistic locking.",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Create a phase in a plan. Position and wbs_code are auto-computed. By default a phase's dates follow its tasks (date_mode 'auto'): once any task in it has dates, the phase runs from the earliest task start to the latest task end and stays in step as tasks change, so there is no need to maintain phase dates by hand. Pass `fields` (for example [\"id\", \"versionTimestamp\"]) for a short answer instead of the whole phase.",
"inputSchema": {
"properties": {
"color": {
"description": "Phase color. Must be one of: #3b82f6 (Blue), #f59e0b (Amber), #8b5cf6 (Purple), #ec4899 (Pink), #06b6d4 (Cyan), #14b8a6 (Teal), #6366f1 (Indigo), #6b7280 (Gray). Red and green are reserved for blocked / done item statuses.",
"enum": [
"#3b82f6",
"#f59e0b",
"#8b5cf6",
"#ec4899",
"#06b6d4",
"#14b8a6",
"#6366f1",
"#6b7280"
],
"type": "string"
},
"date_mode": {
"description": "auto (default): the phase's dates follow its tasks, from the earliest task start to the latest task end, updated whenever a task is added, moved, re-dated or removed; start_date/end_date only hold while no task in the phase has dates. manual: the dates you set are kept as they are.",
"enum": [
"auto",
"manual"
],
"type": "string"
},
"description": {
"type": "string"
},
"end_date": {
"description": "YYYY-MM-DD, on or after start_date. With date_mode 'auto' it is replaced by the tasks' range once a task in the phase has dates.",
"type": "string"
},
"fields": {
"description": "Optional. Answer with only these fields instead of the whole phase, for example [\"id\", \"versionTimestamp\"]. Any of the phase's own fields (snake_case or camelCase) or of the keys around it in the full answer (versionTimestamp, href and, where present, url, title, trackingId, message). The id is always returned, and so is any notice that needs your attention (a note, such as a phase's dates following its tasks or an item's id changing with its type, and a date change's cascadePreview). Unknown names are ignored.",
"items": {
"maxLength": 64,
"type": "string"
},
"maxItems": 50,
"type": "array"
},
"name": {
"type": "string"
},
"planId": {
"type": "string"
},
"position": {
"description": "Position. Auto-computed if omitted.",
"type": "number"
},
"priority": {
"description": "Priority. Default: medium.",
"type": "string"
},
"start_date": {
"description": "YYYY-MM-DD. With date_mode 'auto' it is replaced by the tasks' range once a task in the phase has dates.",
"type": "string"
},
"status": {
"description": "Status: not_started, in_progress, completed, on_hold, cancelled. Default: not_started.",
"type": "string"
},
"wbs_code": {
"description": "WBS code. Auto-computed if omitted.",
"type": "string"
}
},
"required": [
"planId",
"name"
],
"type": "object"
},
"name": "createPlanPhase",
"outputSchema": {
"properties": {
"href": {
"description": "Web URL of the resource in the Stable Baseline app.",
"type": "string"
},
"phase": {
"description": "The phase after the mutation.",
"type": "object"
},
"versionTimestamp": {
"description": "Milliseconds since epoch. Pass back as `versionTimestamp` on subsequent edit/update calls for optimistic locking.",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Create a new project inside a workspace. Mirrors the UI Create Project dialog. Auth: write on workspace + credential's `can_lifecycle` capability. Validates name (1..200) and description (0..2000); icon defaults to a folder emoji if omitted. Server-side limit gate via `can_create_project_in_workspace`. Rate limit 30/min.",
"inputSchema": {
"properties": {
"description": {
"description": "Optional description.",
"maxLength": 2000,
"type": "string"
},
"icon": {
"description": "Optional emoji icon. Defaults to a folder emoji to match the UI.",
"maxLength": 32,
"type": "string"
},
"name": {
"description": "Project name.",
"maxLength": 200,
"minLength": 1,
"type": "string"
},
"workspace_id": {
"description": "Workspace UUID to create the project in.",
"type": "string"
}
},
"required": [
"workspace_id",
"name"
],
"type": "object"
},
"name": "createProject",
"outputSchema": {
"properties": {
"href": {
"description": "Web URL of the resource in the Stable Baseline app.",
"type": "string"
},
"project": {
"description": "The project after the mutation.",
"type": "object"
},
"versionTimestamp": {
"description": "Milliseconds since epoch. Pass back as `versionTimestamp` on subsequent edit/update calls for optimistic locking.",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Create a task in a plan. Requires planId and title. Accepts every field updateTask accepts, so a task can be created complete in ONE call: no create-then-update, and no window in which other actors read a half-written record. Pass parentItemId to create it under its story, requirement or feature in the work hierarchy (which may be in another plan, or in none). Pass `fields` (for example [\"id\", \"friendlyId\", \"versionTimestamp\"]) for a short answer instead of the whole task.",
"inputSchema": {
"properties": {
"acceptance_criteria": {
"description": "Acceptance criteria — ordered list of pass/fail statements that define \"done\" for this item. Each row is `{ id, text }` with server-stamped `updated_at / updated_by / updated_by_credential_name`. REPLACES the whole array on update. Echo back existing `id`s on rows you keep so attribution stamps survive. Bare strings are accepted for convenience (e.g. `[\"row 1\", \"row 2\"]`) and auto-converted to `{ id, text }`.",
"items": {
"anyOf": [
{
"description": "Shorthand for `{ text: \"...\" }`.",
"type": "string"
},
{
"properties": {
"id": {
"description": "Optional — server mints one if omitted. Preserve on edits.",
"type": "string"
},
"text": {
"type": "string"
},
"updated_at": {
"description": "Server-stamped. Echo back unchanged; ignored on new rows.",
"type": "string"
},
"updated_by": {
"description": "Server-stamped user id. Echo back unchanged.",
"type": "string"
},
"updated_by_credential_name": {
"description": "Server-stamped credential label. Echo back unchanged.",
"type": "string"
}
},
"required": [
"text"
],
"type": "object"
}
]
},
"type": "array"
},
"agent_brief": {
"type": "string"
},
"agent_complexity": {
"description": "low, medium, high, very_high.",
"type": "string"
},
"agent_confidence": {
"description": "0.00 to 1.00.",
"type": "number"
},
"agent_missing_info": {
"items": {
"type": "string"
},
"type": "array"
},
"agent_ready": {
"type": "boolean"
},
"agent_recommended_action": {
"type": "string"
},
"business_impact": {
"type": "string"
},
"category_id": {
"description": "Category ID.",
"type": "string"
},
"checklist": {
"description": "Tick-box checklist shown above acceptance_criteria. The full array REPLACES the stored list on update, and array order = display order — to edit, fetch via getTask/getImprovement, modify, and send back the whole list. Operations: mark done with `completed: true`; un-mark with `completed: false`; add rows by appending `{ text }` (id is auto-minted); remove by omitting; reorder by rearranging. Echo back each existing `id` you keep so per-row attribution (who added/completed it, when) survives.",
"items": {
"properties": {
"completed": {
"description": "true = ticked, false/omitted = not done. Server stamps timestamp + actor.",
"type": "boolean"
},
"completed_at": {
"description": "Server-stamped ISO timestamp. Prefer `completed`; an explicit value here wins if both are sent.",
"type": "string"
},
"completed_by": {
"description": "Server-stamped user id. Echo back unchanged.",
"type": "string"
},
"completed_by_credential_name": {
"description": "Server-stamped credential label. Echo back unchanged.",
"type": "string"
},
"due_date": {
"description": "Optional YYYY-MM-DD; null to clear.",
"type": "string"
},
"id": {
"description": "Optional — server mints one if omitted. Preserve on edits.",
"type": "string"
},
"text": {
"type": "string"
},
"updated_at": {
"description": "Server-stamped. Echo back unchanged; ignored on new rows.",
"type": "string"
},
"updated_by": {
"description": "Server-stamped user id. Echo back unchanged.",
"type": "string"
},
"updated_by_credential_name": {
"description": "Server-stamped credential label. Echo back unchanged.",
"type": "string"
}
},
"required": [
"text"
],
"type": "object"
},
"type": "array"
},
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"desired_outcome": {
"type": "string"
},
"end_date": {
"description": "YYYY-MM-DD.",
"type": "string"
},
"fields": {
"description": "Optional. Answer with only these fields instead of the whole task, for example [\"id\", \"versionTimestamp\"]. Any of the task's own fields (snake_case or camelCase) or of the keys around it in the full answer (versionTimestamp, href and, where present, url, title, trackingId, message). The id is always returned, and so is any notice that needs your attention (a note, such as a phase's dates following its tasks or an item's id changing with its type, and a date change's cascadePreview). Unknown names are ignored.",
"items": {
"maxLength": 64,
"type": "string"
},
"maxItems": 50,
"type": "array"
},
"impacted_components": {
"items": {
"type": "string"
},
"type": "array"
},
"impacted_diagrams": {
"description": "Array of {id, name}.",
"items": {
"type": "object"
},
"type": "array"
},
"impacted_documents": {
"description": "Array of {id, title}.",
"items": {
"type": "object"
},
"type": "array"
},
"impacted_repositories": {
"items": {
"type": "string"
},
"type": "array"
},
"linked_document_ids": {
"description": "Document IDs to link. Titles resolved automatically.",
"items": {
"type": "string"
},
"type": "array"
},
"metadata": {
"description": "Free-form JSON stored alongside the task. On updateTask this MERGES rather than replaces.",
"type": "object"
},
"non_goals": {
"items": {
"type": "string"
},
"type": "array"
},
"owner_id": {
"description": "User UUID to assign as owner. MUTUALLY EXCLUSIVE with owner_team_id. Use listAssignablePrincipals(projectId, kind='user') to look up valid UUIDs.",
"type": "string"
},
"owner_team_id": {
"description": "Team UUID to assign as owner (assigns the whole team). MUTUALLY EXCLUSIVE with owner_id. Use listTeams or listAssignablePrincipals(kind='team') to look up valid UUIDs.",
"type": "string"
},
"parentItemId": {
"description": "The work item this one belongs to in the work hierarchy: an epic for a story, a story for its tasks or test cases. Any item in the same project, in any plan or phase. Not the plan outline nesting, which setPlanItemParent sets. Give its UUID or friendly id (such as IMP-12 or TAS-3). Rules: the same project; no loops (an item cannot sit inside its own children); at most 5 levels, counting this item's own children.",
"maxLength": 64,
"type": "string"
},
"percent_complete": {
"description": "Progress percentage (0-100). Null means not tracked.",
"type": "number"
},
"phaseId": {
"description": "Phase to assign to.",
"type": "string"
},
"planId": {
"type": "string"
},
"position": {
"type": "number"
},
"priority": {
"description": "Priority. Default: medium.",
"type": "string"
},
"problem_statement": {
"type": "string"
},
"relationships": {
"description": "Free-form JSON for logical links: blocks, blocked_by, duplicates, supersedes, relates_to (arrays of item IDs).",
"type": "object"
},
"source": {
"description": "Where the work came from. Default: human_manual (shown as a general item), which is right for anything you raise yourself. Use feedback, incident, postmortem, code_review, doc_comment or imported when the item came from one of those. agent_review files the item under Compliance in the register: use it only for a compliance finding.",
"enum": [
"human_manual",
"agent_review",
"doc_comment",
"feedback",
"incident",
"postmortem",
"code_review",
"imported"
],
"type": "string"
},
"source_channel": {
"type": "string"
},
"start_date": {
"description": "YYYY-MM-DD.",
"type": "string"
},
"status": {
"description": "Initial status. Default: captured.",
"enum": [
"captured",
"triaging",
"shaped",
"approved",
"ready_for_agent",
"in_progress",
"ready_for_review",
"in_review",
"blocked",
"done",
"rejected",
"deferred"
],
"type": "string"
},
"target_date": {
"description": "YYYY-MM-DD.",
"type": "string"
},
"title": {
"type": "string"
},
"type": {
"description": "Type. Default: task, which takes a TAS- id. Override only to put another kind of work item in the plan, for example a user_story (a STY- id) or a test_case (a TC- id); the id's prefix follows the type. Valid values: feature, enhancement, bug, tech_debt, architecture_gap, documentation_gap, risk, epic, user_story, requirement, test_case, spike, task.",
"type": "string"
},
"urgency": {
"description": "e.g. this_week, this_month, this_quarter.",
"type": "string"
},
"user_impact": {
"type": "string"
},
"wbs_code": {
"type": "string"
},
"why_now": {
"type": "string"
}
},
"required": [
"planId",
"title"
],
"type": "object"
},
"name": "createTask",
"outputSchema": {
"properties": {
"href": {
"description": "Web URL of the resource in the Stable Baseline app.",
"type": "string"
},
"task": {
"description": "The task after the mutation.",
"type": "object"
},
"versionTimestamp": {
"description": "Milliseconds since epoch. Pass back as `versionTimestamp` on subsequent edit/update calls for optimistic locking.",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Create an FS/SS/FF scheduling edge with lag/lead between two items in the same plan (rendered as a Gantt arrow). FS = Finish-to-Start, SS = Start-to-Start, FF = Finish-to-Finish. `lagDays`: positive = lag, negative = lead/overlap. Rejects self-loops, duplicate (pred+succ+type) edges, cross-plan edges, and cycles.",
"inputSchema": {
"properties": {
"dependencyType": {
"description": "FS = Finish-to-Start, SS = Start-to-Start, FF = Finish-to-Finish.",
"enum": [
"FS",
"SS",
"FF"
],
"type": "string"
},
"lagDays": {
"description": "Lag (positive) or lead (negative) in days. Default 0.",
"type": "integer"
},
"predecessorId": {
"description": "ID of the upstream item (the driver).",
"type": "string"
},
"successorId": {
"description": "ID of the downstream item (the dependent).",
"type": "string"
}
},
"required": [
"predecessorId",
"successorId",
"dependencyType"
],
"type": "object"
},
"name": "createTaskDependency",
"outputSchema": {
"properties": {
"dependency": {
"description": "The dependency after the mutation.",
"type": "object"
},
"href": {
"description": "Web URL of the resource in the Stable Baseline app.",
"type": "string"
},
"versionTimestamp": {
"description": "Milliseconds since epoch. Pass back as `versionTimestamp` on subsequent edit/update calls for optimistic locking.",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Create a new team inside an organisation. Caller is added as the team's lead. Subject to plan team limit. Rate limit 30/min.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"color": {
"description": "Optional 6-digit hex colour. Defaults to #6366f1.",
"pattern": "^#[0-9a-fA-F]{6}$",
"type": "string"
},
"description": {
"maxLength": 2000,
"type": "string"
},
"name": {
"maxLength": 200,
"minLength": 1,
"type": "string"
},
"organisation_id": {
"type": "string"
}
},
"required": [
"organisation_id",
"name"
],
"type": "object"
},
"name": "createTeam",
"outputSchema": {
"properties": {
"href": {
"description": "Web URL of the resource in the Stable Baseline app.",
"type": "string"
},
"team": {
"description": "The team after the mutation.",
"type": "object"
},
"versionTimestamp": {
"description": "Milliseconds since epoch. Pass back as `versionTimestamp` on subsequent edit/update calls for optimistic locking.",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Create a PUT upload URL for a Vega/Vega-Lite data file. Use returned assetUrl in your Vega spec.",
"inputSchema": {
"properties": {
"contentType": {
"description": "MIME type override. Auto-detected from extension if omitted.",
"type": "string"
},
"documentId": {
"type": "string"
},
"fileName": {
"description": "Original filename (e.g. sales-data.csv). Extension auto-detects content type.",
"type": "string"
},
"projectId": {
"description": "Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID.",
"type": "string"
}
},
"required": [
"documentId",
"fileName"
],
"type": "object"
},
"name": "createVegaDataUploadSession",
"outputSchema": {
"properties": {
"expires_at": {
"type": "string"
},
"object_path": {
"type": "string"
},
"upload_url": {
"type": "string"
}
},
"type": "object"
}
},
{
"description": "Create a whiteboard — an infinite Excalidraw canvas. A whiteboard is a hidden document (it won't appear in listDocuments) that hosts a single freeform canvas, and opens in the immersive whiteboard editor in the app. Returns documentId + diagramId. Author shapes afterwards with addWhiteboardElements (high-level specs) or updateWhiteboardScene. For anything beyond a blank board, call getWhiteboardGuide first to plan the layout (stencils vs architecture icons vs code/BPMN diagrams vs plain shapes), and render with getWhiteboardImage to verify as you go.",
"inputSchema": {
"properties": {
"folderId": {
"description": "Optional folder to file the whiteboard under.",
"type": "string"
},
"projectId": {
"type": "string"
},
"title": {
"description": "REQUIRED. A clear, descriptive board name (e.g. 'Q3 GTM plan'). Programmatic boards must be titled — blank/'Untitled' titles are rejected.",
"type": "string"
}
},
"required": [
"projectId",
"title"
],
"type": "object"
},
"name": "createWhiteboard",
"outputSchema": {
"type": "object"
}
},
{
"description": "Create a new workspace inside the organisation. Auth: ceiling — credential must hold `can_lifecycle` AND user must be org owner/admin. Rate limit 30/min. Slug auto-generated. Caller becomes workspace owner. Plan limits surface as WORKSPACE_LIMIT_REACHED errors.",
"inputSchema": {
"properties": {
"name": {
"maxLength": 200,
"minLength": 1,
"type": "string"
},
"organisation_id": {
"description": "Organisation UUID. Must equal the credential's organisation.",
"type": "string"
}
},
"required": [
"organisation_id",
"name"
],
"type": "object"
},
"name": "createWorkspace",
"outputSchema": {
"properties": {
"href": {
"description": "Web URL of the resource in the Stable Baseline app.",
"type": "string"
},
"versionTimestamp": {
"description": "Milliseconds since epoch. Pass back as `versionTimestamp` on subsequent edit/update calls for optimistic locking.",
"type": "number"
},
"workspace": {
"description": "The workspace after the mutation.",
"type": "object"
}
},
"type": "object"
}
},
{
"description": "Render tabular data as an aligned grid of labelled cells on a whiteboard, deterministically. Pass rows (an array of arrays) OR data (an array of objects), with optional headers; the server lays out evenly-spaced cells so you do NOT place each cell by hand. Use this to turn data, CSV, or JSON into a readable table on the board. Returns a compact summary. Auto-places below existing content unless x/y are given.",
"inputSchema": {
"properties": {
"cellHeight": {
"description": "Cell height in px, 28-200 (default 40).",
"type": "number"
},
"cellWidth": {
"description": "Cell width in px, 60-400 (default 160).",
"type": "number"
},
"data": {
"description": "Alternative to rows: an array of objects; columns come from headers, or the first object's keys.",
"items": {
"type": "object"
},
"type": "array"
},
"documentId": {
"description": "The whiteboard's documentId.",
"type": "string"
},
"headers": {
"description": "Optional column headers (rendered as a styled header row). For data, also selects and orders the columns.",
"items": {
"type": "string"
},
"type": "array"
},
"projectId": {
"description": "Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID.",
"type": "string"
},
"rows": {
"description": "Rows as arrays of cell strings. If headers is omitted, the first row is treated as the header row.",
"items": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "array"
},
"x": {
"description": "Top-left x on the canvas. Omit to auto-place below existing content.",
"type": "number"
},
"y": {
"description": "Top-left y on the canvas. Omit to auto-place.",
"type": "number"
}
},
"required": [
"documentId"
],
"type": "object"
},
"name": "dataToTable",
"outputSchema": {
"type": "object"
}
},
{
"description": "Delete a diagram: removes the database record AND every reference to it in the document body — the current marker format plus legacy forms (markers without an embedded diagramId, and old plain-text `[Diagram: name]` placeholders). The response's removedFromBody says whether a marker was actually found in the body, and versionTimestamp is the document's fresh lock token.",
"inputSchema": {
"properties": {
"diagramId": {
"description": "Diagram ID from DIAGRAM_OMITTED markers.",
"type": "string"
},
"versionTimestamp": {
"description": "Optional document optimistic-lock token; validated when provided. (Alias accepted: documentVersionTimestamp.)",
"type": "number"
}
},
"required": [
"diagramId"
],
"type": "object"
},
"name": "deleteDiagramInDocument",
"outputSchema": {
"properties": {
"deleted_id": {
"type": "string"
},
"ok": {
"description": "Alias of success.",
"type": "boolean"
},
"success": {
"description": "True when the deletion completed.",
"type": "boolean"
}
},
"type": "object"
}
},
{
"description": "Delete a document.",
"inputSchema": {
"properties": {
"documentId": {
"type": "string"
},
"projectId": {
"description": "Optional. Narrows a friendly-id lookup to one project. Ignored when documentId is a UUID.",
"type": "string"
}
},
"required": [
"documentId"
],
"type": "object"
},
"name": "deleteDocument",
"outputSchema": {
"properties": {
"deleted_id": {
"type": "string"
},
"ok": {
"description": "Alias of success.",
"type": "boolean"
},
"success": {
"description": "True when the deletion completed.",
"type": "boolean"
}
},
"type": "object"
}
},
{
"description": "Delete a folder recursively, including all nested folders and documents.",
"inputSchema": {
"properties": {
"folderId": {
"type": "string"
}
},
"required": [
"folderId"
],
"type": "object"
},
"name": "deleteFolder",
"outputSchema": {
"properties": {
"deleted_id": {
"type": "string"
},
"ok": {
"description": "Alias of success.",
"type": "boolean"
},
"success": {
"description": "True when the deletion completed.",
"type": "boolean"
}
},
"type": "object"
}
},
{
"description": "Delete an image: removes the stored file, the database record, AND the image from the document body — both the IMAGE marker in the markdown and the image node in the document's rich-text content, so the picture stops appearing on every read. Deleting an image the document still references is the point of this tool; do not hand-edit the marker out with editDocument, which removes the reference but leaves the file and record behind.",
"inputSchema": {
"properties": {
"imageId": {
"description": "Image ID from IMAGE_OMITTED markers.",
"type": "string"
},
"versionTimestamp": {
"description": "Optional document optimistic-lock token; validated when provided. (Alias accepted: documentVersionTimestamp.)",
"type": "number"
}
},
"required": [
"imageId"
],
"type": "object"
},
"name": "deleteImageInDocument",
"outputSchema": {
"properties": {
"deleted_id": {
"type": "string"
},
"ok": {
"description": "Alias of success.",
"type": "boolean"
},
"success": {
"description": "True when the deletion completed.",
"type": "boolean"
}
},
"type": "object"
}
},
{
"description": "Delete an improvement and all associated evidence and activity.",
"inputSchema": {
"properties": {
"improvementId": {
"type": "string"
},
"projectId": {
"description": "Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID.",
"type": "string"
}
},
"required": [
"improvementId"
],
"type": "object"
},
"name": "deleteImprovement",
"outputSchema": {
"properties": {
"deleted_id": {
"type": "string"
},
"ok": {
"description": "Alias of success.",
"type": "boolean"
},
"success": {
"description": "True when the deletion completed.",
"type": "boolean"
}
},
"type": "object"
}
},
{
"description": "Delete an improvement category. Cannot delete system categories.",
"inputSchema": {
"properties": {
"categoryId": {
"type": "string"
}
},
"required": [
"categoryId"
],
"type": "object"
},
"name": "deleteImprovementCategory",
"outputSchema": {
"properties": {
"deleted_id": {
"type": "string"
},
"ok": {
"description": "Alias of success.",
"type": "boolean"
},
"success": {
"description": "True when the deletion completed.",
"type": "boolean"
}
},
"type": "object"
}
},
{
"description": "Delete a comment from an improvement.",
"inputSchema": {
"properties": {
"activityId": {
"description": "Activity ID from getImprovement activity array.",
"type": "string"
}
},
"required": [
"activityId"
],
"type": "object"
},
"name": "deleteImprovementComment",
"outputSchema": {
"properties": {
"deleted_id": {
"type": "string"
},
"ok": {
"description": "Alias of success.",
"type": "boolean"
},
"success": {
"description": "True when the deletion completed.",
"type": "boolean"
}
},
"type": "object"
}
},
{
"description": "Delete a plan, all its phases, and all tasks/improvements within it. This is a destructive operation that cannot be undone.",
"inputSchema": {
"properties": {
"planId": {
"type": "string"
},
"projectId": {
"description": "Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID.",
"type": "string"
}
},
"required": [
"planId"
],
"type": "object"
},
"name": "deletePlan",
"outputSchema": {
"properties": {
"deleted_id": {
"type": "string"
},
"ok": {
"description": "Alias of success.",
"type": "boolean"
},
"success": {
"description": "True when the deletion completed.",
"type": "boolean"
}
},
"type": "object"
}
},
{
"description": "Delete a comment from a plan.",
"inputSchema": {
"properties": {
"activityId": {
"description": "Activity ID from getPlan activity array.",
"type": "string"
}
},
"required": [
"activityId"
],
"type": "object"
},
"name": "deletePlanComment",
"outputSchema": {
"properties": {
"deleted_id": {
"type": "string"
},
"ok": {
"description": "Alias of success.",
"type": "boolean"
},
"success": {
"description": "True when the deletion completed.",
"type": "boolean"
}
},
"type": "object"
}
},
{
"description": "Delete a plan phase and all tasks/improvements within it. This is a destructive operation that cannot be undone.",
"inputSchema": {
"properties": {
"phaseId": {
"type": "string"
},
"planId": {
"description": "Optional. Narrows a friendly-id lookup to one plan, given as the plan's UUID or friendly id (such as PLN-3). Phase ids are numbered per plan, so PHA-2 exists in every plan and planId is what makes one unique. Ignored when phaseId is a UUID.",
"type": "string"
},
"projectId": {
"description": "Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID.",
"type": "string"
}
},
"required": [
"phaseId"
],
"type": "object"
},
"name": "deletePlanPhase",
"outputSchema": {
"properties": {
"deleted_id": {
"type": "string"
},
"ok": {
"description": "Alias of success.",
"type": "boolean"
},
"success": {
"description": "True when the deletion completed.",
"type": "boolean"
}
},
"type": "object"
}
},
{
"description": "Delete a resource_permissions row. Refuses if the row is the LAST admin grant on the resource. Rate limit 30/min. Use when the user asks to revoke access, remove access, take away access, unshare, or delete a permission grant on a specific resource.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"permission_id": {
"description": "UUID of the resource_permissions row to delete",
"type": "string"
}
},
"required": [
"permission_id"
],
"type": "object"
},
"name": "deleteResourcePermission",
"outputSchema": {
"properties": {
"deleted_id": {
"type": "string"
},
"ok": {
"description": "Alias of success.",
"type": "boolean"
},
"success": {
"description": "True when the deletion completed.",
"type": "boolean"
}
},
"type": "object"
}
},
{
"description": "Remove a task-dependency edge. Neither item's dates are changed. Needs the same 'write' plan permission as createTaskDependency, so an actor that can draw an edge can also undo it — the edge is fully recreatable from (predecessor, successor, type, lag).",
"inputSchema": {
"properties": {
"dependencyId": {
"type": "string"
}
},
"required": [
"dependencyId"
],
"type": "object"
},
"name": "deleteTaskDependency",
"outputSchema": {
"properties": {
"deleted_id": {
"type": "string"
},
"ok": {
"description": "Alias of success.",
"type": "boolean"
},
"success": {
"description": "True when the deletion completed.",
"type": "boolean"
}
},
"type": "object"
}
},
{
"description": "Delete a team. Cascades: team members and team-granted resource permissions are removed automatically. Destructive; rate limit 5/min.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"team_id": {
"type": "string"
}
},
"required": [
"team_id"
],
"type": "object"
},
"name": "deleteTeam",
"outputSchema": {
"properties": {
"deleted_id": {
"type": "string"
},
"ok": {
"description": "Alias of success.",
"type": "boolean"
},
"success": {
"description": "True when the deletion completed.",
"type": "boolean"
}
},
"type": "object"
}
},
{
"description": "Delete a data file attachment from a document.",
"inputSchema": {
"properties": {
"attachmentId": {
"description": "Attachment ID to delete.",
"type": "string"
},
"documentId": {
"type": "string"
},
"projectId": {
"description": "Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID.",
"type": "string"
}
},
"required": [
"documentId",
"attachmentId"
],
"type": "object"
},
"name": "deleteVegaDataFile",
"outputSchema": {
"properties": {
"deleted_id": {
"type": "string"
},
"ok": {
"description": "Alias of success.",
"type": "boolean"
},
"success": {
"description": "True when the deletion completed.",
"type": "boolean"
}
},
"type": "object"
}
},
{
"description": "Delete a whiteboard (the host document and its canvas).",
"inputSchema": {
"properties": {
"documentId": {
"type": "string"
},
"projectId": {
"description": "Optional. Narrows a friendly-id lookup to one project. Ignored when documentId is a UUID.",
"type": "string"
}
},
"required": [
"documentId"
],
"type": "object"
},
"name": "deleteWhiteboard",
"outputSchema": {
"properties": {
"deleted_id": {
"type": "string"
},
"ok": {
"description": "Alias of success.",
"type": "boolean"
},
"success": {
"description": "True when the deletion completed.",
"type": "boolean"
}
},
"type": "object"
}
},
{
"description": "Design ONE reusable, on-brand SLIDE COMPONENT and add it to the org's component library so every future branded deck (autoDesignWhiteboard designProfile:'branded-executive') can use it. This is the self-improving design loop: an agent AUTHORS the component as a declarative template (a gradient/shadow/curve SVG skin + a native editable PPTX shape + reflowing bound-text slots), RENDERS it, a vision critic COMPARES the render to your brief and lists gaps, and it FIXES + re-renders until polished — then validates and stores it. Use it to grow the deck component catalogue beyond the built-ins (e.g. a 'kpi.delta' stat with an up/down arrow, a 'quote.card', a 'logo.strip'). Browse-first: if a component with this `key` already exists it is reused (pass force:true to redesign). Provide example `sampleSlots` so it can lay out real content, and a `projectId` for the small preview board it builds. Returns the stored component, the per-round critique trail, and the preview board id. It uses a few AI calls + renders (no flat credit charge); the new component is then free to reuse forever.",
"inputSchema": {
"properties": {
"boxCols": {
"description": "Optional width in grid columns (2-12, default 4).",
"type": "number"
},
"boxRows": {
"description": "Optional height in grid rows (2-12, default 5).",
"type": "number"
},
"brandKitId": {
"description": "Optional brand kit id (from listBrandKits) to theme the component. If omitted, the organisation's effective brand is used.",
"type": "string"
},
"category": {
"description": "Optional catalogue category (e.g. 'data', 'narrative', 'comparison').",
"type": "string"
},
"description": {
"description": "What the component IS, WHEN to use it, and what it should LOOK like (the richer the better — this drives both the designer and the critic).",
"type": "string"
},
"force": {
"description": "Redesign even if a component with this key already exists (default false = reuse).",
"type": "boolean"
},
"key": {
"description": "The component key, lowercase dotted, e.g. 'kpi.delta'. This is how decks reference it; reused if it already exists.",
"type": "string"
},
"projectId": {
"description": "Project to create the small preview board in (where the render iterations are shown).",
"type": "string"
},
"referenceImageUrl": {
"description": "Optional URL of a reference image the component should match; the critic compares the render to it.",
"type": "string"
},
"sampleSlots": {
"additionalProperties": true,
"description": "Example slot content to render with, e.g. { value: '47%', label: 'Revenue growth', delta: '+12 pts' }. The slot keys become the component's editable fields.",
"type": "object"
},
"tags": {
"description": "Optional search tags.",
"items": {
"type": "string"
},
"type": "array"
},
"title": {
"description": "A short human title, e.g. 'KPI with delta arrow'.",
"type": "string"
}
},
"required": [
"key",
"title",
"description",
"projectId",
"sampleSlots"
],
"type": "object"
},
"name": "designComponent",
"outputSchema": {
"type": "object"
}
},
{
"description": "Create or refine a slide deck INSIDE an existing whiteboard by conversing with the AI design agent. Send a brief for a NEW deck, a change to an EXISTING one, or an answer to the agent's question. The agent builds a polished, on-brand deck and places it on the board; if the brief is ambiguous it asks ONE clarifying question (answer with the same sessionId). Returns immediately; poll getDeckReplyInWhiteboard for the result. Use for building or editing slide decks / presentations. WHITEBOARD IS REQUIRED: a deck always lives inside a whiteboard, so documentId (the whiteboard's id) is required. If you do NOT already have a whiteboard id, ASK THE USER which whiteboard they want the deck designed in — do NOT create a whiteboard automatically. Only call createWhiteboard first if the user explicitly asks for a brand-new board; otherwise use the id of the whiteboard they name. FIRST vs FOLLOW-UP: the first call (from nothing) builds; a follow-up call (an answer, a change, or a new instruction) passes the sessionId (or the deckId) plus the new message. kind:'deck' (default) is the premium on-brand HTML deck; kind:'express' builds the native, deterministic branded-executive deck directly on the whiteboard (faster, lower fidelity, one-shot, not conversational). COST + APPROVAL: a build costs 50 credits per 30 slides (1 to 30 slides is 50, 31 to 60 is 100, and so on, with the second and later blocks charged once the deck is built and never charged twice for the same block), an edit costs a flat 50, and a clarifying question is FREE. It can also generate imagery for the deck where the design calls for it. ADVANCED DECK BUILDING (optional, OFF by default): set advancedDeckBuilding:true to build the deck over several rounds of redraft and review by a panel of design, brand, accessibility and copy reviewers instead of one composer pass. It usually raises design quality, but it is not a guarantee. It is much slower and it costs more: a standard build takes roughly 2 to 8 minutes, advanced deck building takes roughly 15 to 20 minutes, and it adds 15 credits per depth level on top of the turn fee (advancedDeckBuildingDepth is 1 to 3, default 3, so +45 credits, making a 50-credit build cost 95). Only turn it on when the user asks for the highest quality and accepts the wait and the cost. Call FIRST without confirm to get the exact cost plus the workspace balance, show it to the user, and only call again with confirm:true once they agree. The fee is auto-refunded if a turn produces no change or fails. Returns sessionId (the conversation), deckId (the deck), status, turnType, started, awaitingUser, needsConfirmation, insufficientCredits, slideCount (the target the conversation now carries) and slideCountClamped (always false; nothing reduces a slide count), advancedDeckBuilding (whether advanced deck building is on for this conversation), advancedDeckBuildingStatus, and assistantMessage. Export the finished deck with exportFromWhiteboard.",
"inputSchema": {
"properties": {
"advancedDeckBuilding": {
"description": "Optional, OFF by default. Build the deck with ADVANCED DECK BUILDING: instead of one composer pass, the deck is redrafted and reviewed over several rounds by a panel of design, brand, accessibility and copy reviewers, each round scoring the deck and listing what must be fixed. It usually produces a higher-quality deck, but it is not a guarantee. TIME: a standard build takes roughly 2 to 8 minutes; advanced deck building takes roughly 15 to 20 minutes. COST: 15 extra credits per depth level on top of the turn fee, so the default depth of 3 adds 45 credits and makes a 50-credit build cost 95. This is the user's deliberate choice, so only switch it on when they have asked for the best possible deck and accepted the wait and the cost. Quote the turn FIRST (call without confirm) so the user sees the real total before approving. Set it once and it is remembered for the rest of the conversation; pass false to turn it off again.",
"type": "boolean"
},
"advancedDeckBuildingDepth": {
"description": "Optional. How many redraft-and-review rounds advanced deck building may run: 1 to 3, default 3. Each round is a full redraft plus four reviews, adds roughly 5 minutes, and costs 15 credits (depth 1 = +15, depth 2 = +30, depth 3 = +45). Ignored unless advancedDeckBuilding is true.",
"type": "number"
},
"attachments": {
"description": "Optional reference images for THIS turn (up to 8; images only). The agent lifts palette, layout, and tone from them (it does not pixel-copy). Non-image attachments are ignored.",
"items": {
"description": "One reference image: give a public url, OR base64 data plus its mediaType.",
"properties": {
"data": {
"description": "The image as base64 (no data: prefix). Provide mediaType alongside it.",
"type": "string"
},
"mediaType": {
"description": "The image MIME type, e.g. 'image/png' or 'image/jpeg'.",
"type": "string"
},
"name": {
"description": "Optional human-readable name for the image.",
"type": "string"
},
"type": {
"description": "Optional attachment type hint, passed through to the design worker.",
"type": "string"
},
"url": {
"description": "A public https URL to the image.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"brandKitId": {
"description": "Optional brand kit id (from listBrandKits) to theme the deck. If omitted, the organisation's effective brand is used.",
"type": "string"
},
"confirm": {
"description": "Set true ONLY after the user has approved the cost (50 for a build, 10 for an edit). Leave unset/false on the first call of a turn to receive the cost quote plus balance. A clarifying question turn is never charged.",
"type": "boolean"
},
"deckId": {
"description": "Optional. An existing deck to continue designing (usually you pass sessionId instead; when both are given the session's deck wins).",
"type": "string"
},
"documentId": {
"description": "The whiteboard the deck lives in. REQUIRED: a deck cannot exist without a whiteboard, and this is that whiteboard's id. If you do not already have a whiteboard id, ASK THE USER which whiteboard to design the deck in — never create one automatically. Only call createWhiteboard first if the user explicitly wants a new board.",
"type": "string"
},
"imageCount": {
"description": "Deprecated and ignored. Still accepted so existing callers do not break; passing it changes nothing.",
"type": "number"
},
"kind": {
"description": "Which engine. 'deck' (default) = the premium on-brand HTML deck (conversational, build + edit); 'illustration' and 'design' are conversational variants. 'express' = the native, deterministic branded-executive deck (faster, lower fidelity, one-shot, not conversational).",
"enum": [
"deck",
"illustration",
"design",
"express"
],
"type": "string"
},
"message": {
"description": "This turn's message in plain language: the design brief on the first turn, an edit instruction later, or the user's ANSWER to a clarifying question the agent asked. On a follow-up turn, pass this together with the sessionId (or deckId) from the earlier call. If the user mentioned how many slides they want, ALSO pass slideCount with that number — never leave the count only in prose, and never outline more slides in this message than slideCount.",
"type": "string"
},
"sessionId": {
"description": "The design conversation to continue, as returned by an earlier designDeckInWhiteboard call. Pass it together with message to answer a question, make an edit, or send a follow-up. Omit on the very first call to start a new conversation.",
"type": "string"
},
"slideCount": {
"description": "The number of slides to build — a hard requirement: the deck is built with exactly this many slides. SET THIS whenever the user states or implies a count, EXACT OR APPROXIMATE: '12 slides' → 12, 'about 15' / '15 or so' → 15, 'no more than 10' → 10. Never expand the user's number: if they said 'about 15', pass 15 and shape the brief to fit 15 — outlining 19 sections in the message does not raise the count, it just fights this parameter. It is PERSISTED on the conversation, so send it ONCE (on the turn that states it) and every later build turn of the same conversation carries it automatically; send it again only to CHANGE the target. It is honoured on edit turns too ('cut it to 8 slides'). THERE IS NO MAXIMUM: ask for 40, 60 or 100 slides and that is what gets built. Longer decks cost proportionally more (50 credits per 30 slides) and take proportionally longer. Omit ONLY when the user gave no count at all; the designer then chooses (typical 6 to 12).",
"type": "number"
},
"title": {
"description": "Optional title. If omitted, a clear one is derived from the brief.",
"type": "string"
}
},
"required": [
"documentId",
"message"
],
"type": "object"
},
"name": "designDeckInWhiteboard",
"outputSchema": {
"type": "object"
}
},
{
"description": "Create or refine a standalone ILLUSTRATION INSIDE an existing whiteboard by conversing with the AI design agent. This is the illustration sibling of designDeckInWhiteboard: same conversation, same follow-up flow, but it makes ONE on-brand illustration placed on the board (not a slide deck). Send a brief for a NEW illustration, a change to an existing one, or an answer to the agent's question. The agent generates the illustration, places it on the board, and if the brief is ambiguous it asks ONE clarifying question (answer with the same sessionId). Returns immediately; poll getDeckReplyInWhiteboard for the result. Use it when the user wants a picture they can talk about and refine turn by turn (e.g. 'draw a friendly robot onboarding a new team', then 'make it warmer', 'add a second robot'). For a quick one-shot illustration with no follow-up, use generateIllustrationInWhiteboard instead. WHITEBOARD IS REQUIRED: an illustration always lives inside a whiteboard, so documentId (the whiteboard's id) is required. If you do NOT already have a whiteboard id, ASK THE USER which whiteboard they want the illustration designed in — do NOT create a whiteboard automatically. Only call createWhiteboard first if the user explicitly asks for a brand-new board; otherwise use the id of the whiteboard they name. FIRST vs FOLLOW-UP: the first call (from nothing) builds; a follow-up call (an answer, a change, or a new instruction) passes the sessionId (or the deckId) plus the new message. COST + APPROVAL: a build costs 50 credits per 30 slides (1 to 30 slides is 50, 31 to 60 is 100, and so on, with the second and later blocks charged once the deck is built and never charged twice for the same block), an edit costs a flat 50, and a clarifying question is FREE. Call FIRST without confirm to get the exact cost plus the workspace balance, show it to the user, and only call again with confirm:true once they agree. The fee is auto-refunded if a turn produces no change or fails. Returns sessionId (the conversation), deckId (the illustration's id), status, turnType, started, awaitingUser, needsConfirmation, insufficientCredits, and assistantMessage.",
"inputSchema": {
"properties": {
"attachments": {
"description": "Optional reference images for THIS turn (up to 8; images only). The agent lifts palette, layout, and tone from them (it does not pixel-copy). Non-image attachments are ignored.",
"items": {
"description": "One reference image: give a public url, OR base64 data plus its mediaType.",
"properties": {
"data": {
"description": "The image as base64 (no data: prefix). Provide mediaType alongside it.",
"type": "string"
},
"mediaType": {
"description": "The image MIME type, e.g. 'image/png' or 'image/jpeg'.",
"type": "string"
},
"name": {
"description": "Optional human-readable name for the image.",
"type": "string"
},
"type": {
"description": "Optional attachment type hint, passed through to the design worker.",
"type": "string"
},
"url": {
"description": "A public https URL to the image.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"brandKitId": {
"description": "Optional brand kit id (from listBrandKits) to colour-condition the illustration. If omitted, the organisation's effective brand is used.",
"type": "string"
},
"confirm": {
"description": "Set true ONLY after the user has approved the cost (50 for a build, 10 for an edit). Leave unset/false on the first call of a turn to receive the cost quote plus balance. A clarifying question turn is never charged.",
"type": "boolean"
},
"deckId": {
"description": "Optional. An existing illustration to continue refining (usually you pass sessionId instead; when both are given the session's illustration wins). The id is called deckId because illustrations and decks share the same conversation spine.",
"type": "string"
},
"documentId": {
"description": "The whiteboard the illustration lives in. REQUIRED: an illustration cannot exist without a whiteboard, and this is that whiteboard's id. If you do not already have a whiteboard id, ASK THE USER which whiteboard to design the illustration in — never create one automatically. Only call createWhiteboard first if the user explicitly wants a new board.",
"type": "string"
},
"message": {
"description": "This turn's message in plain language: the illustration brief on the first turn, a change instruction later, or the user's ANSWER to a clarifying question the agent asked. On a follow-up turn, pass this together with the sessionId (or deckId) from the earlier call.",
"type": "string"
},
"sessionId": {
"description": "The design conversation to continue, as returned by an earlier designIllustrationInWhiteboard call. Pass it together with message to answer a question, make a change, or send a follow-up. Omit on the very first call to start a new conversation.",
"type": "string"
},
"title": {
"description": "Optional title. If omitted, a clear one is derived from the brief.",
"type": "string"
}
},
"required": [
"documentId",
"message"
],
"type": "object"
},
"name": "designIllustrationInWhiteboard",
"outputSchema": {
"type": "object"
}
},
{
"description": "Per-item: clear `needs_dependency_review` without changing dates — keeps the edge, ignores the suggestion. Use when the successor should stay put despite the predecessor shifting.",
"inputSchema": {
"properties": {
"improvementId": {
"type": "string"
}
},
"required": [
"improvementId"
],
"type": "object"
},
"name": "dismissTaskDependencyReview",
"outputSchema": {
"properties": {
"applied": {
"description": "True when the apply call has been atomically committed.",
"type": "boolean"
},
"ok": {
"type": "boolean"
}
},
"type": "object"
}
},
{
"description": "Copy-paste existing whiteboard elements — the MCP equivalent of selecting a group and pressing Ctrl/Cmd+D. Clones the given elements (plus their group peers + bound text/labels) with FRESH ids, offsets the copy by dx/dy, and by default groups it into ONE new unit so it moves together. Use it to build something once (a labelled stencil frame, a kanban card, a UML class) then stamp out consistent repeats fast — then retext/recolour each copy by its new id (via the returned idMap) with updateWhiteboardScene. Pass `groupId` to copy a whole group as a unit (e.g. a placed stencil's groupId from its placement result) and/or `ids` for specific elements. Internal references (group membership, bound text containerId, arrow start/end bindings) are remapped within the copied set; a binding to an element you did NOT copy is dropped. Returns { duplicated, idMap (old id → new id), groupId (the copy's new unit group), elementCount }. Render with getWhiteboardImage afterwards to verify.",
"inputSchema": {
"properties": {
"documentId": {
"description": "The whiteboard's documentId.",
"type": "string"
},
"dx": {
"description": "Horizontal offset for the copy (default 40). Use the element width + a gap to place copies side by side.",
"type": "number"
},
"dy": {
"description": "Vertical offset for the copy (default 40).",
"type": "number"
},
"group": {
"description": "Group the copy into one new unit so it moves/duplicates together (default true).",
"type": "boolean"
},
"groupId": {
"description": "Copy EVERY element in this group as one unit — e.g. a placed stencil's `groupId` returned by addWhiteboardElements.",
"type": "string"
},
"ids": {
"description": "Element ids to copy. Each id's full group + any bound text are auto-included. Use this and/or groupId.",
"items": {
"type": "string"
},
"type": "array"
},
"includeGroupPeers": {
"description": "Auto-include the full group of any id you pass (default true).",
"type": "boolean"
}
},
"required": [
"documentId"
],
"type": "object"
},
"name": "duplicateWhiteboardElements",
"outputSchema": {
"type": "object"
}
},
{
"description": "Edit a document: the PREFERRED tool for small targeted changes. Two patch dialects — do NOT mix them in one call. (1) ANCHOR patches {oldText, newText, before?, after?} — RECOMMENDED: replace an exact snippet of existing text with new text. oldText must match the document byte-for-byte AND be unique; if it occurs more than once, either expand oldText until it is unique, or add `before`/`after` (the EXACT text immediately before/after the match) to disambiguate. A no-match returns nearby context; an ambiguous match returns the occurrence count. Anchors do NOT drift, so you don't need fresh line numbers and they survive concurrent edits. Use newText:\"\" to delete. (2) LINE patches {startLine, endLine, replacement} — 1-based and INCLUSIVE: call getDocument first for line numbers; replace line 5 with {startLine:5,endLine:5}; INSERT before line N (deleting nothing) with {startLine:N,endLine:N-1}; append to an L-line document with {startLine:L+1,endLine:L}. Line numbers are ABSOLUTE and GO STALE after ANY edit — re-call getDocument before further line patches; out-of-range patches are rejected with the current line count. versionTimestamp from getDocument (or from any mutating tool's response — they all return the fresh token) is required for optimistic locking, EXCEPT when dryRun:true. If your token is stale, the error tells you who changed the document, when, and the currentVersionTimestamp — anchor patches survive concurrent edits, so retrying with that token is usually safe. Set dryRun:true to apply the patches and get the resulting text back WITHOUT saving (verify before committing — kills retry loops). IMPORTANT: getDocument displays lines as `NNNNN<TAB>content`; that prefix is display-only — oldText/before/after must contain only the content AFTER the tab. Do not edit or delete DIAGRAM/IMAGE marker lines (rejected with guidance) — use dedicated diagram/image tools. To @-mention a person, insert `<!-- REFERENCE: {\"type\":\"user\",\"id\":\"<user_uuid>\",\"label\":\"Name\"} -->`; look up the user_id via listAssignablePrincipals. Mentioned users are notified automatically.",
"inputSchema": {
"properties": {
"changeSummary": {
"description": "Version history summary.",
"type": "string"
},
"documentId": {
"type": "string"
},
"dryRun": {
"description": "If true, apply the patches and RETURN the resulting document text without saving — no version bump, no lock required. Use to preview/verify a patch before committing. Default false.",
"type": "boolean"
},
"expectedVersion": {
"description": "Legacy integer version guard, checked in addition to versionTimestamp. Prefer versionTimestamp — this exists for older clients and is optional.",
"type": "number"
},
"folderId": {
"description": "MOVE the document into this folder (null moves it to the project root). Send it with patches:[] to file the document without touching its content — a folder-only move updates folder_id, creates NO version-history entry, and does not bump the document version. To move many documents at once use reorderDocuments, which takes folderId per item.",
"type": [
"string",
"null"
]
},
"patches": {
"description": "Patches to apply. Use EITHER anchor patches OR line patches, not both in the same call. May be empty if only updating title, folderId, or position.",
"items": {
"oneOf": [
{
"description": "Anchor patch (recommended): replace an exact, unique snippet of existing text. Drift-proof — no line numbers needed.",
"properties": {
"after": {
"description": "Optional. Text that appears immediately after oldText, used to disambiguate.",
"type": "string"
},
"before": {
"description": "Optional. Text that appears immediately before oldText, used to disambiguate when oldText occurs more than once.",
"type": "string"
},
"newText": {
"description": "Replacement text. Empty string to delete the matched text.",
"type": "string"
},
"oldText": {
"description": "Exact existing text to replace. Must match the document byte-for-byte and be unique (or use before/after to disambiguate).",
"type": "string"
}
},
"required": [
"oldText",
"newText"
],
"type": "object"
},
{
"description": "Line patch: 1-based inclusive line range. Requires fresh line numbers from getDocument().",
"properties": {
"endLine": {
"description": "1-based end line (inclusive).",
"type": "number"
},
"replacement": {
"description": "Replacement text. Empty string to delete lines.",
"type": "string"
},
"startLine": {
"description": "1-based start line.",
"type": "number"
}
},
"required": [
"startLine",
"endLine",
"replacement"
],
"type": "object"
}
]
},
"type": "array"
},
"position": {
"description": "Sort position within the parent folder. Use to reposition a single document; like folderId, a position-only change creates no version. For batch sibling reorder/move, use reorderDocuments.",
"type": "number"
},
"projectId": {
"description": "Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID.",
"type": "string"
},
"title": {
"description": "New title.",
"type": "string"
},
"versionTimestamp": {
"description": "Optimistic-lock token from getDocument() or any mutating tool's response. Required unless dryRun:true. (Alias accepted: documentVersionTimestamp.)",
"type": "number"
}
},
"required": [
"documentId"
],
"type": "object"
},
"name": "editDocument",
"outputSchema": {
"properties": {
"document": {
"type": "object"
},
"href": {
"description": "Web URL of the resource in the Stable Baseline app.",
"type": "string"
},
"versionTimestamp": {
"description": "Milliseconds since epoch. Pass back as `versionTimestamp` on subsequent edit/update calls for optimistic locking.",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Mask-edit (inpaint) one region of an image element on a whiteboard. Given the target image element id and a paint MASK (a PNG where WHITE marks the area to regenerate and BLACK is kept), it regenerates only the masked region using the prompt and replaces the image IN PLACE (same position + size). This is mainly used by the in-app image-board mask editor for boards designed with designProfile:'image'. It is available to every organisation; the small flat credit charge is the only gate (refunded automatically if the edit fails on our side).",
"inputSchema": {
"properties": {
"documentId": {
"description": "The whiteboard document that holds the image element.",
"type": "string"
},
"elementId": {
"description": "The id of the image element on the board to edit (from getWhiteboard includeElements=true).",
"type": "string"
},
"maskBase64": {
"contentEncoding": "base64",
"description": "A PNG mask (base64, with or without a data: prefix) the same shape as the image. WHITE pixels are regenerated; BLACK pixels are preserved.",
"type": "string"
},
"prompt": {
"description": "What to put in the masked area, in plain language (e.g. 'replace the car with a red bicycle').",
"type": "string"
},
"strength": {
"description": "Optional 0..1: how far the regenerated area may diverge from the original. The editing model may balance this from the prompt instead, so leave it unset unless you need it.",
"type": "number"
}
},
"required": [
"documentId",
"elementId",
"maskBase64",
"prompt"
],
"type": "object"
},
"name": "editWhiteboardImageRegion",
"outputSchema": {
"type": "object"
}
},
{
"description": "Export a design that lives in a whiteboard to an editable PowerPoint (PPTX), a PDF, or PNG images. LARGE DECKS FINISH IN THE BACKGROUND: if the export takes longer than one tool call can wait, this returns status:'exporting' with a jobId instead of the file — wait about 30 seconds and call this tool AGAIN with the SAME arguments to collect it. Repeat until status is 'completed' and 'url' is present. Nothing is re-exported while a job is already running, so polling is cheap and safe. Download links are available for 1 hour. Give it the whiteboard documentId and the designId (the deck). kind:'deck' (default) renders the finished deck via the export worker: 'pptx' = native, fully-editable PowerPoint (real shapes and text, not screenshots); 'pdf' = vector, one page per slide; 'png' = one image per slide. HTML is not an available format — do not ask for it. Small exports come back as base64 in data (pptx/pdf); anything larger, and every png export, comes back as download links. The design must be finished; one that is still generating, failed, or archived returns a clear message.",
"inputSchema": {
"properties": {
"brandKitId": {
"description": "Optional brand kit id (reserved for future per-export theming; the design is already branded, so this is usually unnecessary).",
"type": "string"
},
"designId": {
"description": "The design to export (the deck id), as returned by designDeckInWhiteboard.",
"type": "string"
},
"documentId": {
"description": "The whiteboard that hosts the design.",
"type": "string"
},
"format": {
"description": "Output format. 'pptx' (default) = editable PowerPoint; 'pdf' = vector PDF; 'png' = one image per slide. HTML is not available.",
"enum": [
"pptx",
"pdf",
"png"
],
"type": "string"
},
"kind": {
"description": "Which engine. 'deck' (default).",
"enum": [
"deck"
],
"type": "string"
}
},
"required": [
"documentId",
"designId"
],
"type": "object"
},
"name": "exportFromWhiteboard",
"outputSchema": {
"type": "object"
}
},
{
"description": "Find and replace EXACT substrings in a document (NOT regex: wildcards and patterns are matched literally). Replaces EVERY occurrence and returns the replacement count; best for renames and repeated phrases. For a single targeted change at a known location, prefer editDocument (anchor patches). Case-sensitive by default. Diagrams/images are automatically protected — only document text is affected. Returns document.versionTimestamp (the fresh optimistic-lock token) like every other mutating tool, so you can chain straight into editDocument or the diagram tools. Pass versionTimestamp to opt into optimistic locking (optional here — whole-document find/replace is position-independent). Note: when the `replace` value contains a `<!-- REFERENCE: {...} -->` marker (e.g. inserting a user mention), it round-trips losslessly through the editor and triggers notifications if it adds a new user mention.",
"inputSchema": {
"properties": {
"caseSensitive": {
"description": "Case-sensitive matching. Default: true.",
"type": "boolean"
},
"changeSummary": {
"description": "Version history summary.",
"type": "string"
},
"documentId": {
"type": "string"
},
"find": {
"description": "Text to search for.",
"type": "string"
},
"projectId": {
"description": "Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID.",
"type": "string"
},
"replace": {
"description": "Replacement text. Empty string to delete occurrences.",
"type": "string"
},
"versionTimestamp": {
"description": "Optional optimistic-lock token from getDocument() or a previous write; validated when provided. (Alias accepted: documentVersionTimestamp.)",
"type": "number"
}
},
"required": [
"documentId",
"find",
"replace"
],
"type": "object"
},
"name": "findAndReplaceTextInDocument",
"outputSchema": {
"properties": {
"document": {
"type": "object"
},
"href": {
"description": "Web URL of the resource in the Stable Baseline app.",
"type": "string"
},
"replacements": {
"description": "Count of substitutions made.",
"type": "number"
},
"versionTimestamp": {
"description": "Milliseconds since epoch. Pass back as `versionTimestamp` on subsequent edit/update calls for optimistic locking.",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Get the CDMD markdown language specification. Call before createDocument if unfamiliar with syntax.",
"inputSchema": {
"properties": {},
"type": "object"
},
"name": "getCdmdLanguageGuide",
"outputSchema": {
"description": "CDMD authoring guide.",
"type": "object"
}
},
{
"description": "Composite credit balance for an organisation: plan_credits (recurring monthly bucket), top_up_credits (purchased one-offs, gross), bonus_credits (admin grants), total, and period_end (next plan reset).",
"inputSchema": {
"properties": {
"organisation_id": {
"description": "UUID of the organisation. Must match the credential's organisation.",
"type": "string"
}
},
"required": [
"organisation_id"
],
"type": "object"
},
"name": "getCreditBalance",
"outputSchema": {
"properties": {
"balance": {
"type": "number"
},
"currency": {
"type": "string"
}
},
"type": "object"
}
},
{
"description": "List active credit packages available for purchase (name, credits, bonus_credits, price in cents AUD). Catalog read — visible to any MCP credential. Pair with createCreditPurchaseLink (Phase 6) to start a checkout.",
"inputSchema": {
"properties": {},
"type": "object"
},
"name": "getCreditPackages",
"outputSchema": {
"properties": {
"packages": {
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
{
"description": "Read the plan entitlements (limits + capability flags) that apply to the caller's organisation. Returns { tier, display_name, limits, features }. The Enterprise row is filtered for non-admin callers by the underlying view. Read-only.",
"inputSchema": {
"properties": {
"organisation_id": {
"description": "Organisation UUID. Must equal the credential's organisation.",
"type": "string"
}
},
"required": [
"organisation_id"
],
"type": "object"
},
"name": "getCurrentPlanEntitlements",
"outputSchema": {
"description": "Current org tier, feature flags, seat counts and KG eligibility.",
"type": "object"
}
},
{
"description": "Return the calling user's identity (user_id, display_name, full_name, email, avatar_url). Use this when the user says 'me' / 'mine' / 'I' so you can resolve to their UUID before passing it to tools like updateImprovement(owner_id=…) or filtering by owner. Read-only.",
"inputSchema": {
"properties": {},
"type": "object"
},
"name": "getCurrentUser",
"outputSchema": {
"properties": {
"avatar_url": {
"type": [
"string",
"null"
]
},
"display_name": {
"type": [
"string",
"null"
]
},
"email": {
"type": [
"string",
"null"
]
},
"full_name": {
"type": [
"string",
"null"
]
},
"preferred_name": {
"type": [
"string",
"null"
]
},
"user_id": {
"description": "The authenticated user's UUID.",
"type": "string"
}
},
"type": "object"
}
},
{
"description": "Mint a single-use Stripe Customer Portal URL for self-serve billing changes. return_url defaults to https://app.stablebaseline.io/settings/billing and must be on a stablebaseline.* host.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"organisation_id": {
"type": "string"
},
"return_url": {
"type": "string"
}
},
"required": [
"organisation_id"
],
"type": "object"
},
"name": "getCustomerPortalLink",
"outputSchema": {
"properties": {
"url": {
"description": "Stripe Customer Portal URL — single-use, short TTL.",
"type": "string"
}
},
"type": "object"
}
},
{
"description": "Get the design agent's reply after calling designDeckInWhiteboard OR designIllustrationInWhiteboard: the status (thinking/building/ready) and EITHER the finished result (a deck's slide count + preview, or the placed illustration) OR a clarifying question to answer (call the SAME tool you started with, passing the sessionId + your answer). Poll until ready or a question appears. Give it the whiteboard documentId and the deckId (both returned by the tool you called). It returns the build status ('generating' while working, 'ready' when finished, 'failed' if it failed) plus, once ready, the slide count and a thumbnail image URL. IMPORTANT for the conversation: if the agent asked a CLARIFYING QUESTION instead of doing the work, this returns awaitingUser:true with pendingQuestion (and assistantMessage) — relay that question to the user, then call the SAME design tool again with the same sessionId and the user's answer as message to continue. It also returns the full conversation (history + status + pending question). While a turn is running it additionally returns live build state: stage, percent, feed (the agent's real per-step lines), slideTarget (the count it is building to), slides (the finished slides so far, each with a fetchable image url), partialHtml (the deck so far), and, when advanced deck building is on, advancedDeckBuildingProgress (the round-by-round reviewer scores; also emitted as the deprecated `jury` field for one release). Every one of those is optional and absent when there is nothing to report. A standard turn usually takes about 2 to 8 minutes, so poll every 15 to 30 seconds until it is 'ready' or awaitingUser is true; a turn running with advanced deck building takes roughly 15 to 20 minutes, so keep polling for that long before treating it as stuck. When ready, the deck or illustration has already been placed on the whiteboard; a deck can also be exported with exportFromWhiteboard. If a turn failed or produced no change, the user was not charged.",
"inputSchema": {
"properties": {
"deckId": {
"description": "The deck or illustration to poll, as returned by designDeckInWhiteboard or designIllustrationInWhiteboard.",
"type": "string"
},
"documentId": {
"description": "The whiteboard that hosts the deck or illustration (it lives inside the board). REQUIRED.",
"type": "string"
}
},
"required": [
"documentId",
"deckId"
],
"type": "object"
},
"name": "getDeckReplyInWhiteboard",
"outputSchema": {
"type": "object"
}
},
{
"description": "Render a diagram that ALREADY exists in a document to an IMAGE (svg/png/jpeg @1x/2x/3x) and return it — a temporary imageUrl available for 1 hour plus, for png/jpeg, the image inline so you can see it, and title/url citing the document the diagram lives in. Pass the diagramId (from getDocument's DIAGRAM markers or getDiagramInDocument). Reuses the diagram's cached server render when available (pixel-identical to the editor), otherwise renders from the diagram's source on the fly. Read-only: nothing in the document or the diagram is changed; the image is a temporary artefact that expires after 1 hour. Use renderDiagram instead to generate from raw DSL without an existing diagram.",
"inputSchema": {
"properties": {
"background": {
"description": "Background for png/jpeg, e.g. '#ffffff' or 'transparent' (png only).",
"type": "string"
},
"diagramId": {
"description": "The diagram's id (from getDocument markers / getDiagramInDocument).",
"type": "string"
},
"format": {
"description": "png (default) or jpeg = raster; svg is scalable. A platform default diagram's SVG contains a browser foreignObject scene, so use PNG/JPEG where foreignObject SVG is unsupported.",
"enum": [
"png",
"jpeg",
"svg"
],
"type": "string"
},
"scale": {
"description": "Raster resolution multiplier 1x/2x/3x (default 2). Ignored for svg.",
"enum": [
1,
2,
3
],
"type": "number"
}
},
"required": [
"diagramId"
],
"type": "object"
},
"name": "getDiagramImage",
"outputSchema": {
"type": "object"
}
},
{
"description": "Get a diagram's full details including raw DSL source code. Use diagramId from DIAGRAM_OMITTED markers in getDocument output. Returns diagramCode, type, name, nlDescription, renderStatus/renderError, and versionTimestamp — the diagram's optimistic-lock token for updateDiagramInDocument (every diagram write also returns it fresh).",
"inputSchema": {
"properties": {
"diagramId": {
"description": "Diagram ID from DIAGRAM_OMITTED markers.",
"type": "string"
},
"fields": {
"description": "Field projection. Valid fields: diagramId, documentId, type, name, diagramCode, nlDescription, colorPlan, renderStatus, renderError, createdAt, updatedAt, versionTimestamp.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"diagramId"
],
"type": "object"
},
"name": "getDiagramInDocument",
"outputSchema": {
"properties": {
"diagram": {
"type": "object"
}
},
"type": "object"
}
},
{
"description": "Get DSL writing instructions and an example for a diagram type (a renderer such as 'default', 'mermaid' or 'bpmn'). Also accepts a diagram family slug or name from supportedDiagrams (e.g. 'bpmn-process'), which resolves to that family's default renderer (see resolvedFrom). supportedDiagrams lists the families the type draws, each with its defaultRenderer. Call before writing diagramCode.",
"inputSchema": {
"properties": {
"fields": {
"description": "Field projection. Valid fields: type, label, description, whenToUse, dslLanguage, dslInstructions, exampleDsl, enabled, sortOrder, updatedAt.",
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"description": "A diagram type from listDiagramTypes (e.g. 'default', 'mermaid', 'bpmn'), or a diagram family slug or name (e.g. 'bpmn-process'), which resolves to the family's default renderer.",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"name": "getDiagramTypeGuide",
"outputSchema": {
"description": "DSL writing instructions for the requested diagram type.",
"properties": {
"diagramType": {
"description": "The catalogue row: type, label, whenToUse, dslInstructions, exampleDsl and so on.",
"type": "object"
},
"note": {
"description": "Set when this type is only an alternative renderer: the default renderer of each family it draws.",
"type": "string"
},
"resolvedFrom": {
"description": "Set when `type` named a diagram family: the family and a note naming its default renderer.",
"type": "object"
},
"supportedDiagrams": {
"description": "The diagram families this type draws, each with its defaultRenderer.",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
{
"description": "Read a document's content with line numbers. content.text lines are formatted `NNNNN<TAB>content` (cat -n style); the number+tab prefix is DISPLAY ONLY — never part of the document — so when building editDocument anchor patches, copy only the text AFTER the tab. Reads paginate by lines (offset/limit, default 200): use content.totalLines and content.nextOffset to page. document.versionTimestamp is the optimistic-lock token that every mutating document tool accepts (as versionTimestamp; the older documentVersionTimestamp name also works) — and every mutating tool returns a fresh token, so you rarely need to re-read just to keep editing. Diagrams/images appear as OMITTED markers with metadata (type, diagramId, renderStatus, nlDescription) — use getDiagramInDocument(diagramId) for full DSL code, or pass includeDiagramDsl:true to inline each diagram's DSL and versionTimestamp directly into its DIAGRAM_OMITTED marker (saves a getDiagramInDocument call when you intend to read or edit diagrams).",
"inputSchema": {
"properties": {
"contentFields": {
"description": "Content field projection. Valid fields: offset, limit, totalLines, nextOffset, metadata, text.",
"items": {
"type": "string"
},
"type": "array"
},
"documentId": {
"description": "The document ID to read. Accepts either the UUID or the friendly id (e.g. DOC-815); friendly ids are resolved within your organisation.",
"type": "string"
},
"fields": {
"description": "Field projection. Valid fields: id, title, friendlyId, friendlyIdNumber, projectId, folderId, createdAt, updatedAt, versionTimestamp.",
"items": {
"type": "string"
},
"type": "array"
},
"includeDiagramDsl": {
"description": "If true, inline each diagram's full DSL (as diagramCode) and its versionTimestamp into the DIAGRAM_OMITTED markers, so you can inspect and then edit a diagram (updateDiagramInDocument with diagramVersionTimestamp) without a second read. Default false. Note: large DSL inflates the response.",
"type": "boolean"
},
"limit": {
"description": "Max lines to return. Default: 200.",
"type": "number"
},
"offset": {
"description": "Lines to skip from start. Default: 0.",
"type": "number"
},
"projectId": {
"description": "Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID.",
"type": "string"
}
},
"required": [
"documentId"
],
"type": "object"
},
"name": "getDocument",
"outputSchema": {
"properties": {
"content": {
"description": "Numbered text lines for editDocument input.",
"type": "object"
},
"document": {
"type": "object"
},
"href": {
"description": "Web URL of the resource in the Stable Baseline app.",
"type": "string"
},
"versionTimestamp": {
"description": "Milliseconds since epoch. Pass back as `versionTimestamp` on subsequent edit/update calls for optimistic locking.",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Read the current status of an ingest job. Returns { status, stage, processedImages, totalImages, documentId, error?, lastHeartbeatAt }. Stages: pending → downloaded → extracted → draft_saved → images_processing → finalized → cleaned_up. Status: queued, running, succeeded, failed, cancelled. The associated document_id is populated immediately and progressively filled in as images are processed.",
"inputSchema": {
"properties": {
"jobId": {
"type": "string"
}
},
"required": [
"jobId"
],
"type": "object"
},
"name": "getDocumentIngestJob",
"outputSchema": {
"properties": {
"job": {
"type": "object"
}
},
"type": "object"
}
},
{
"description": "Compute a user's effective permission level on a resource (taking team grants, inheritance, and 3-state overrides into account) and the source. Asking about another user requires can_manage_perms on the org. Use when the user asks 'can X access this', 'what level of access does X have', 'why can X see this', or to debug an unexpected permission outcome.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"resource_id": {
"type": "string"
},
"resource_type": {
"enum": [
"workspace",
"project",
"folder",
"document",
"improvement",
"plan"
],
"type": "string"
},
"user_id": {
"description": "UUID of the user to check",
"type": "string"
}
},
"required": [
"user_id",
"resource_type",
"resource_id"
],
"type": "object"
},
"name": "getEffectivePermission",
"outputSchema": {
"properties": {
"effective_level": {
"type": [
"string",
"null"
]
},
"sources": {
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
{
"description": "Get the folder and document tree. Pass folderId for the subtree under one folder, or projectId for the project's ENTIRE folder tree from the root (no need to reassemble listFolders' flat list by parentId). Alias for getProjectHierarchy.",
"inputSchema": {
"properties": {
"dateField": {
"description": "Date field to filter. Default: updated_at.",
"type": "string"
},
"folderId": {
"description": "The folder ID to start from. Omit and pass projectId to get the project root hierarchy.",
"type": "string"
},
"fromDate": {
"description": "ISO 8601 date filter (from).",
"type": "string"
},
"includeDocuments": {
"description": "Include documents. Default: true.",
"type": "boolean"
},
"maxDepth": {
"description": "Max nesting depth. Default: 10, max: 20.",
"type": "number"
},
"projectId": {
"description": "Return the whole project's folder tree from the root. Provide this or folderId.",
"type": "string"
},
"query": {
"description": "Filter by name/title (case-insensitive).",
"type": "string"
},
"toDate": {
"description": "ISO 8601 date filter (to).",
"type": "string"
}
},
"type": "object"
},
"name": "getFolderHierarchy",
"outputSchema": {
"properties": {
"documents": {
"items": {
"type": "object"
},
"type": "array"
},
"folder": {
"type": "object"
},
"folders": {
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
{
"description": "Get image details including a fresh signed URL (expires after 1 hour). Use storagePath from IMAGE_OMITTED markers in getDocument output.",
"inputSchema": {
"properties": {
"documentId": {
"type": "string"
},
"storagePath": {
"description": "Storage path from IMAGE_OMITTED marker.",
"type": "string"
}
},
"required": [
"documentId",
"storagePath"
],
"type": "object"
},
"name": "getImageInDocument",
"outputSchema": {
"properties": {
"image": {
"type": "object"
}
},
"type": "object"
}
},
{
"description": "Get full details for an improvement item including evidence, activity log, compliance context, and the `checklist` array (each item: id, text, due_date, completed_at, plus server-stamped attribution). Returns versionTimestamp: pass it to updateImprovement for optimistic locking. (For tasks specifically, use getTask + updateTask which are symmetric aliases.) Also returns the work hierarchy: parentItem (the item this one belongs to, such as its epic or story: { id, friendlyId, title, type, status, isTask }, or null), children (the items that belong to it, in status order then by id, at most 200: each with ownerId, ownerTeamId and percentComplete) and childProgress { total, done, closed } over every child (closed counts done, rejected and deferred). Set a parent with parentItemId on updateImprovement or updateTask.",
"inputSchema": {
"properties": {
"improvementId": {
"description": "Accepts either the UUID or the friendly id (e.g. IMP-42); friendly ids are resolved within your organisation.",
"type": "string"
},
"projectId": {
"description": "Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID.",
"type": "string"
}
},
"required": [
"improvementId"
],
"type": "object"
},
"name": "getImprovement",
"outputSchema": {
"properties": {
"href": {
"description": "Web URL of the resource in the Stable Baseline app.",
"type": "string"
},
"improvement": {
"description": "The improvement resource.",
"type": "object"
},
"versionTimestamp": {
"description": "Milliseconds since epoch. Pass back as `versionTimestamp` on subsequent edit/update calls for optimistic locking.",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "List every kg_scope row for the caller's organisation, optionally narrowed to a workspace or project subtree. Each row carries scope_type, scope_id, state (on|off|inherit), settings, and is augmented with scope_name + parent_id for tree rendering. Capped at 500 rows.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"organisation_id": {
"description": "Must match the credential's org",
"type": "string"
},
"project_id": {
"description": "Optional — narrow the result to this project's subtree",
"type": "string"
},
"workspace_id": {
"description": "Optional — narrow the result to this workspace's subtree",
"type": "string"
}
},
"required": [
"organisation_id"
],
"type": "object"
},
"name": "getKgScopeTree",
"outputSchema": {
"properties": {
"rows": {
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
{
"description": "Get a meeting scribe's status after startMeetingScribe: the session state (joining, in the waiting room, live in the call, paused, ending, ended, or failed), the live activity feed of what the scribe has painted, and the board it is painting. Give it the sessionId returned by startMeetingScribe. Poll every 15 to 30 seconds while the meeting runs. When the meeting ends the board holds the finished 'meeting map' (topics, decisions, actions, and a summary).",
"inputSchema": {
"properties": {
"sessionId": {
"description": "The meeting scribe session to poll, as returned by startMeetingScribe.",
"type": "string"
}
},
"required": [
"sessionId"
],
"type": "object"
},
"name": "getMeetingScribeStatus",
"outputSchema": {
"type": "object"
}
},
{
"description": "Fetch a single organisation member by user_id, enriched with profile (email + display name). Auth: org id must match the credential's organisation.",
"inputSchema": {
"properties": {
"organisation_id": {
"description": "Organisation UUID. Must match the credential's organisation.",
"type": "string"
},
"user_id": {
"description": "User UUID of the member to fetch.",
"type": "string"
}
},
"required": [
"organisation_id",
"user_id"
],
"type": "object"
},
"name": "getMember",
"outputSchema": {
"properties": {
"href": {
"description": "Web URL of the resource in the Stable Baseline app.",
"type": "string"
},
"member": {
"description": "The member resource.",
"type": "object"
},
"versionTimestamp": {
"description": "Milliseconds since epoch. Pass back as `versionTimestamp` on subsequent edit/update calls for optimistic locking.",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Read an organisation's settings JSON and the derived enabled-features map (plans, documents, improvements, compliance, knowledge_graph — all booleans). The organisation must match the calling credential's organisation. Read-only.",
"inputSchema": {
"properties": {
"organisation_id": {
"description": "Organisation UUID. Must equal the credential's organisation.",
"type": "string"
}
},
"required": [
"organisation_id"
],
"type": "object"
},
"name": "getOrgSettings",
"outputSchema": {
"properties": {
"enabledFeatures": {
"type": "object"
},
"settings": {
"type": "object"
}
},
"type": "object"
}
},
{
"description": "Read a single organisation by id. Returns id, name, slug, description, settings (jsonb), created_at, member_count (active members) and plan_tier (subscription_tier). The organisation must match the calling credential's organisation. Read-only.",
"inputSchema": {
"properties": {
"organisation_id": {
"description": "Organisation UUID. Must equal the credential's organisation.",
"type": "string"
}
},
"required": [
"organisation_id"
],
"type": "object"
},
"name": "getOrganisation",
"outputSchema": {
"properties": {
"href": {
"description": "Web URL of the resource in the Stable Baseline app.",
"type": "string"
},
"organisation": {
"description": "The organisation resource.",
"type": "object"
},
"versionTimestamp": {
"description": "Milliseconds since epoch. Pass back as `versionTimestamp` on subsequent edit/update calls for optimistic locking.",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Get full plan details including phases, items, and activity. Every level carries its own optimistic-lock token, so one call supplies them all: the top-level versionTimestamp is the plan's (for updatePlan), phases[].versionTimestamp each phase's (for updatePlanPhase) and items[].versionTimestamp each task's or improvement's (for updateTask / updateImprovement, including their bulk `items` form). Items include percent_complete for progress tracking.",
"inputSchema": {
"properties": {
"planId": {
"description": "Accepts either the UUID or the friendly id (e.g. PLN-3); friendly ids are resolved within your organisation.",
"type": "string"
},
"projectId": {
"description": "Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID.",
"type": "string"
}
},
"required": [
"planId"
],
"type": "object"
},
"name": "getPlan",
"outputSchema": {
"properties": {
"href": {
"description": "Web URL of the resource in the Stable Baseline app.",
"type": "string"
},
"plan": {
"description": "The plan resource.",
"type": "object"
},
"versionTimestamp": {
"description": "Milliseconds since epoch. Pass back as `versionTimestamp` on subsequent edit/update calls for optimistic locking.",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Get the complete plan hierarchy (phases, tasks, improvements) in one call. Recommended first call for plan navigation.",
"inputSchema": {
"properties": {
"planId": {
"description": "Accepts either the UUID or the friendly id (e.g. PLN-3); friendly ids are resolved within your organisation.",
"type": "string"
},
"projectId": {
"description": "Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID.",
"type": "string"
}
},
"required": [
"planId"
],
"type": "object"
},
"name": "getPlanHierarchy",
"outputSchema": {
"properties": {
"phases": {
"items": {
"type": "object"
},
"type": "array"
},
"plan": {
"type": "object"
},
"tasks": {
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
{
"description": "Get a plan phase by ID with full details. Returns versionTimestamp — pass it to updatePlanPhase for optimistic locking.",
"inputSchema": {
"properties": {
"phaseId": {
"description": "Accepts either the UUID or the friendly id (e.g. PHA-7); friendly ids are resolved within your organisation.",
"type": "string"
},
"planId": {
"description": "Optional. Narrows a friendly-id lookup to one plan, given as the plan's UUID or friendly id (such as PLN-3). Phase ids are numbered per plan, so PHA-2 exists in every plan and planId is what makes one unique. Ignored when phaseId is a UUID.",
"type": "string"
},
"projectId": {
"description": "Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID.",
"type": "string"
}
},
"required": [
"phaseId"
],
"type": "object"
},
"name": "getPlanPhase",
"outputSchema": {
"properties": {
"href": {
"description": "Web URL of the resource in the Stable Baseline app.",
"type": "string"
},
"phase": {
"description": "The phase resource.",
"type": "object"
},
"versionTimestamp": {
"description": "Milliseconds since epoch. Pass back as `versionTimestamp` on subsequent edit/update calls for optimistic locking.",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Read the public catalog entry for a single subscription tier (free, pro, enterprise). Pro/Free pricing is publicly advertised; Enterprise pricing is custom — pricing fields are nullified for non-admin callers.",
"inputSchema": {
"properties": {
"tier": {
"description": "Subscription tier.",
"enum": [
"free",
"pro",
"enterprise"
],
"type": "string"
}
},
"required": [
"tier"
],
"type": "object"
},
"name": "getPriceForTier",
"outputSchema": {
"description": "Per-tier price and seat limits.",
"type": "object"
}
},
{
"description": "Read a single project by id. Auth via the standard project-access ladder. Returns the full v_projects row (id, workspace_id, name, description, icon, created_by/at, updated_by/at). Read-only.",
"inputSchema": {
"properties": {
"project_id": {
"description": "Project UUID.",
"type": "string"
}
},
"required": [
"project_id"
],
"type": "object"
},
"name": "getProject",
"outputSchema": {
"properties": {
"href": {
"description": "Web URL of the resource in the Stable Baseline app.",
"type": "string"
},
"project": {
"description": "The project resource.",
"type": "object"
},
"versionTimestamp": {
"description": "Milliseconds since epoch. Pass back as `versionTimestamp` on subsequent edit/update calls for optimistic locking.",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Get the complete folder and document tree for a project in one call. Recommended first call for navigation.",
"inputSchema": {
"properties": {
"dateField": {
"description": "Date field to filter. Default: updated_at.",
"type": "string"
},
"folderId": {
"description": "Start from this folder instead of project root.",
"type": "string"
},
"fromDate": {
"description": "ISO 8601 date filter (from).",
"type": "string"
},
"includeDocuments": {
"description": "Include documents. Default: true.",
"type": "boolean"
},
"maxDepth": {
"description": "Max nesting depth. Default: 10, max: 20.",
"type": "number"
},
"projectId": {
"description": "Project ID. Required if folderId not provided.",
"type": "string"
},
"query": {
"description": "Filter by name/title (case-insensitive).",
"type": "string"
},
"toDate": {
"description": "ISO 8601 date filter (to).",
"type": "string"
}
},
"type": "object"
},
"name": "getProjectHierarchy",
"outputSchema": {
"properties": {
"documents": {
"items": {
"type": "object"
},
"type": "array"
},
"folders": {
"items": {
"type": "object"
},
"type": "array"
},
"plans": {
"items": {
"type": "object"
},
"type": "array"
},
"project": {
"type": "object"
}
},
"type": "object"
}
},
{
"description": "Read the subscription state for an organisation. Returns tier, status, current billing period, seat count, member count, cancellation flag, trial end. Stripe IDs are stripped. Pair with listPaymentMethods/listInvoices for the full billing dashboard. Use when the user asks 'what plan am I on', 'how many seats do I have', 'when does my subscription renew', or to check current billing status.",
"inputSchema": {
"properties": {
"organisation_id": {
"description": "UUID of the organisation. Must match the credential's organisation.",
"type": "string"
}
},
"required": [
"organisation_id"
],
"type": "object"
},
"name": "getSubscription",
"outputSchema": {
"type": "object"
}
},
{
"description": "Get a task by ID with full details, evidence, activity, and the `checklist` array (each item: id, text, due_date, completed_at, plus server-stamped attribution). Returns versionTimestamp; pass it to updateTask to modify. Includes percent_complete for progress tracking. Also returns the work hierarchy: parentItem (the item this one belongs to, such as its epic or story: { id, friendlyId, title, type, status, isTask }, or null), children (the items that belong to it, in status order then by id, at most 200: each with ownerId, ownerTeamId and percentComplete) and childProgress { total, done, closed } over every child (closed counts done, rejected and deferred). Set a parent with parentItemId on updateImprovement or updateTask.",
"inputSchema": {
"properties": {
"projectId": {
"description": "Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID.",
"type": "string"
},
"taskId": {
"description": "Accepts either the UUID or the friendly id (e.g. TAS-176); friendly ids are resolved within your organisation.",
"type": "string"
}
},
"required": [
"taskId"
],
"type": "object"
},
"name": "getTask",
"outputSchema": {
"properties": {
"href": {
"description": "Web URL of the resource in the Stable Baseline app.",
"type": "string"
},
"task": {
"description": "The task resource.",
"type": "object"
},
"versionTimestamp": {
"description": "Milliseconds since epoch. Pass back as `versionTimestamp` on subsequent edit/update calls for optimistic locking.",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Get a single team by ID with profile-enriched member list (display_name, email, avatar_url, role, joined_at). Set `includeMembers=false` to skip the member fan-out and just return team metadata. Read-only.",
"inputSchema": {
"properties": {
"includeMembers": {
"description": "Include the team's members enriched with user profile info. Default true.",
"type": "boolean"
},
"teamId": {
"description": "Team UUID.",
"type": "string"
}
},
"required": [
"teamId"
],
"type": "object"
},
"name": "getTeam",
"outputSchema": {
"properties": {
"href": {
"description": "Web URL of the resource in the Stable Baseline app.",
"type": "string"
},
"team": {
"description": "The team resource.",
"type": "object"
},
"versionTimestamp": {
"description": "Milliseconds since epoch. Pass back as `versionTimestamp` on subsequent edit/update calls for optimistic locking.",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Read the calling user's preferences. Self-only — no params required. Returns { notifications, grids } where `notifications` is the single notification-preferences row and `grids` is an array of per-grid view rows. Read-only.",
"inputSchema": {
"properties": {},
"type": "object"
},
"name": "getUserPreferences",
"outputSchema": {
"properties": {
"preferences": {
"type": "object"
}
},
"type": "object"
}
},
{
"description": "Read a whiteboard: its metadata plus a summary of the canvas (element count, element types, and text labels on the board). Pass includeElements=true to also return the full Excalidraw scene ({elements, appState, files}) — needed if you intend to modify it and send it back via updateWhiteboardScene. FOR BEST RESULTS, also call getWhiteboardImage to render the board to an image and actually SEE it: the visual layout (positions, spacing, overlaps, colours, how shapes connect) is far easier to understand from the rendered picture than from the element list, so view it first to truly understand the board and to propose or verify edits accurately.",
"inputSchema": {
"properties": {
"documentId": {
"description": "Accepts either the UUID or the friendly id (e.g. WBD-12); friendly ids are resolved within your organisation.",
"type": "string"
},
"includeElements": {
"description": "When true, returns the full Excalidraw scene so it can be modified and written back.",
"type": "boolean"
},
"projectId": {
"description": "Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID.",
"type": "string"
}
},
"required": [
"documentId"
],
"type": "object"
},
"name": "getWhiteboard",
"outputSchema": {
"type": "object"
}
},
{
"description": "Get the Stable Baseline whiteboarding guide (Markdown): when to use stencils vs architecture icons vs code/BPMN diagrams vs plain shapes vs real images vs frames/presentations, how to lay out and verify a board, and how to edit a large board safely (patch by id, never replace). Call before authoring a non-trivial whiteboard.",
"inputSchema": {
"properties": {},
"type": "object"
},
"name": "getWhiteboardGuide",
"outputSchema": {
"type": "object"
}
},
{
"description": "Render a whiteboard to a raster IMAGE so you can SEE it and confirm your edits look right, then iterate — like taking a screenshot. Returns the rendered board as a viewable image attached to the result (always raster: a JPEG light variant and/or a PNG dark variant; there is no vector/SVG output, so for a vector export of a single diagram use getDiagramImage). Pass elementIds to render only specific shapes (e.g. to inspect one section/slide), region:{x,y,width,height} to capture an exact scene-coordinate window (e.g. the user's viewport), theme:'light' for the fastest single-variant render, or background to set the canvas colour. Unchanged boards return instantly from a content-keyed cache. Call this after addWhiteboardElements/updateWhiteboardScene to check layout, overlaps, labels and alignment before continuing.",
"inputSchema": {
"properties": {
"background": {
"description": "Canvas background colour (default white), e.g. '#ffffff' or 'transparent'.",
"type": "string"
},
"documentId": {
"description": "The whiteboard's documentId. Accepts either the UUID or the friendly id (e.g. WBD-12); friendly ids are resolved within your organisation.",
"type": "string"
},
"elementIds": {
"description": "Render only these element ids (plus their bound labels + group peers) instead of the whole board.",
"items": {
"type": "string"
},
"type": "array"
},
"projectId": {
"description": "Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID.",
"type": "string"
},
"region": {
"description": "Capture only this scene-coordinate window instead of the whole board — e.g. the user's current viewport, or the neighbourhood you are editing. The output is cropped to the exact rectangle.",
"properties": {
"height": {
"description": "Window height (> 0).",
"type": "number"
},
"width": {
"description": "Window width (> 0).",
"type": "number"
},
"x": {
"description": "Window left edge (scene coordinates).",
"type": "number"
},
"y": {
"description": "Window top edge (scene coordinates).",
"type": "number"
}
},
"required": [
"x",
"y",
"width",
"height"
],
"type": "object"
},
"theme": {
"description": "Which theme variant(s) to render. 'light' is fastest and right for inspecting your own edits; 'both' (default) also produces the dark variant used by the chat widget.",
"enum": [
"light",
"dark",
"both"
],
"type": "string"
}
},
"required": [
"documentId"
],
"type": "object"
},
"name": "getWhiteboardImage",
"outputSchema": {
"type": "object"
}
},
{
"description": "Read a single workspace by id. Auth via the standard workspace-access ladder (credential org match + workspace scope + per-resource read permission). Returns the full v_workspaces row. Read-only.",
"inputSchema": {
"properties": {
"workspace_id": {
"description": "Workspace UUID.",
"type": "string"
}
},
"required": [
"workspace_id"
],
"type": "object"
},
"name": "getWorkspace",
"outputSchema": {
"properties": {
"href": {
"description": "Web URL of the resource in the Stable Baseline app.",
"type": "string"
},
"versionTimestamp": {
"description": "Milliseconds since epoch. Pass back as `versionTimestamp` on subsequent edit/update calls for optimistic locking.",
"type": "number"
},
"workspace": {
"description": "The workspace resource.",
"type": "object"
}
},
"type": "object"
}
},
{
"description": "Grant a team read/write/admin access to a workspace. Idempotent. Team and workspace must be in the same organisation.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"permission_level": {
"enum": [
"read",
"write",
"admin"
],
"type": "string"
},
"team_id": {
"type": "string"
},
"workspace_id": {
"type": "string"
}
},
"required": [
"team_id",
"workspace_id",
"permission_level"
],
"type": "object"
},
"name": "grantTeamWorkspaceAccess",
"outputSchema": {
"properties": {
"access": {
"type": "object"
}
},
"type": "object"
}
},
{
"description": "Insert a new diagram into a document. Call listDiagramTypes to find your type, then getDiagramTypeGuide for DSL syntax before writing diagramCode. The diagramCode is COMPILE-CHECKED BY RENDERING at write time: broken DSL is rejected with the renderer's error (fix and retry), and valid DSL is rendered + thumbnailed immediately so the document displays instantly everywhere. The response tells you what happened: diagram.renderStatus ('rendered' | 'pending_render' with renderError when the renderer was unavailable), plus fresh optimistic-lock tokens — document.versionTimestamp and diagram.versionTimestamp — so you can keep editing without re-reading. Always set prompt (and ideally nlDescription) to describe what the diagram shows. To SEE the result inline set returnImage:true, or call getDiagramImage afterwards; if it is wrong or ugly, correct it with updateDiagramInDocument (provide the full updated diagramCode).",
"inputSchema": {
"properties": {
"afterLine": {
"description": "Insert after this line, counting the SAME line numbers getDocument prints (1-based; frontmatter is not counted, and every diagram/image marker counts as exactly one line). 0 inserts at the very beginning; omit it to append at the end. Re-read with getDocument if the document may have changed, since the number is positional.",
"type": "number"
},
"align": {
"description": "Alignment.",
"enum": [
"left",
"center",
"right"
],
"type": "string"
},
"applyBrandTheme": {
"description": "Brand theming is ON BY DEFAULT: the document's effective BRAND KIT (colours only — typefaces are never injected) is baked into the diagram DSL before it is validated, rendered and stored, so the diagram is on-brand everywhere it appears (cascade: brandKitId override → project default → workspace default → org default → the built-in Stable Baseline theme). Set false to keep the library's stock styling. Themable types: mermaid, plantuml, graphviz, d2, systemsarchitecture, vega, vegalite, infographic — other types (incl. bpmn, which has colorPlan) are always stored unchanged. Author theming in the DSL wins (an existing mermaid %%{init}%%, plantuml !theme, d2 vars.d2-config, or a hand-written infographic palette is never overridden). The stored diagramCode is the THEMED source.",
"type": "boolean"
},
"brandKitId": {
"description": "Optional brand kit UUID (see listBrandKits) to theme with instead of the cascade default. Must belong to your organisation.",
"type": "string"
},
"caption": {
"description": "Caption below the diagram.",
"type": "string"
},
"colorPlan": {
"description": "BPMN only. Color plan: { byElementId: { ElementId: SwatchName } }.",
"properties": {
"byElementId": {
"additionalProperties": {
"type": "string"
},
"description": "Map of element IDs to color swatch names.",
"type": "object"
}
},
"required": [
"byElementId"
],
"type": "object"
},
"diagramCode": {
"description": "Diagram DSL code. Call getDiagramTypeGuide for syntax. For 'default', provide MDP JSON with stable IDs and omit every entity x/y for automatic layout; fully positioned manual diagrams are also supported, and icons must be exact iconKey values from listArchitectureIcons. EXCEPTION — for type 'infographic', put a plain-English DESCRIPTION of the infographic here (NOT code); the system designs the AntV spec and renders it.",
"type": "string"
},
"documentId": {
"type": "string"
},
"documentVersionTimestamp": {
"description": "Optimistic-lock token: the document's versionTimestamp from getDocument() or any mutating tool's response. (Alias accepted: versionTimestamp.)",
"type": "number"
},
"imageBackground": {
"description": "Background for the returned png/jpeg (e.g. '#ffffff' or 'transparent').",
"type": "string"
},
"imageFormat": {
"description": "Image format when returnImage:true (default png).",
"enum": [
"png",
"jpeg",
"svg"
],
"type": "string"
},
"imageScale": {
"description": "Raster resolution 1x/2x/3x when returnImage:true (default 2).",
"enum": [
1,
2,
3
],
"type": "number"
},
"nlDescription": {
"description": "Extended description of the diagram (2-4 sentences).",
"type": "string"
},
"projectId": {
"description": "Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID.",
"type": "string"
},
"prompt": {
"description": "Short description of what the diagram shows (1-2 sentences).",
"type": "string"
},
"returnImage": {
"description": "If true, also render the inserted diagram and return it as an image inline (one-call insert-and-get-image). Defaults false.",
"type": "boolean"
},
"type": {
"description": "Diagram type, meaning the renderer (e.g. default, mermaid, plantuml, bpmn, d2; 'default' is the platform default renderer). For a diagram family such as a BPMN process, an ERD or a flowchart, use the family's defaultRenderer from listDiagramTypes or getDiagramTypeGuide. Call listDiagramTypes for all types.",
"type": "string"
}
},
"required": [
"documentId",
"type",
"diagramCode",
"prompt"
],
"type": "object"
},
"name": "insertDiagramInDocument",
"outputSchema": {
"properties": {
"diagram": {
"type": "object"
},
"href": {
"description": "Web URL of the resource in the Stable Baseline app.",
"type": "string"
},
"versionTimestamp": {
"description": "Milliseconds since epoch. Pass back as `versionTimestamp` on subsequent edit/update calls for optimistic locking.",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Insert an image into a document (max 10MB). Provide imageBase64, imageBinary, or imageUrl. For large files, call createImageUploadSession first then use the returned assetUrl. nlDescription AND caption are both REQUIRED, not optional polish: they are what makes the image findable in search and what lets an agent decide whether this picture belongs on a slide or in an answer, since neither can see the pixels from a filename. Write them about what the image SHOWS.",
"inputSchema": {
"properties": {
"afterLine": {
"description": "Insert after this line, counting the SAME line numbers getDocument prints (1-based; frontmatter is not counted, and every diagram/image marker counts as exactly one line). 0 inserts at the very beginning; omit it to append at the end. Re-read with getDocument if the document may have changed, since the number is positional.",
"type": "number"
},
"align": {
"description": "Alignment. Default: center.",
"enum": [
"left",
"center",
"right"
],
"type": "string"
},
"alt": {
"description": "Alt text. Defaults to caption.",
"type": "string"
},
"caption": {
"description": "Caption below the image.",
"type": "string"
},
"documentId": {
"type": "string"
},
"documentVersionTimestamp": {
"description": "Optimistic-lock token: the document's versionTimestamp from getDocument() or any mutating tool's response. (Alias accepted: versionTimestamp.)",
"type": "number"
},
"fileName": {
"description": "Original filename.",
"type": "string"
},
"height": {
"description": "Height in pixels.",
"type": "number"
},
"imageBase64": {
"contentEncoding": "base64",
"description": "Base64-encoded image data. Mutually exclusive with imageBinary/imageUrl.",
"type": "string"
},
"imageBinary": {
"description": "Raw binary as byte array. Mutually exclusive with imageBase64/imageUrl.",
"items": {
"type": "number"
},
"type": "array"
},
"imageUrl": {
"description": "URL to fetch image from, or assetUrl from createImageUploadSession.",
"type": "string"
},
"nlDescription": {
"description": "Description of image content for semantic search.",
"type": "string"
},
"projectId": {
"description": "Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID.",
"type": "string"
},
"width": {
"description": "Width in pixels.",
"type": "number"
}
},
"required": [
"documentId",
"nlDescription",
"caption"
],
"type": "object"
},
"name": "insertImageInDocument",
"outputSchema": {
"properties": {
"href": {
"description": "Web URL of the resource in the Stable Baseline app.",
"type": "string"
},
"image": {
"type": "object"
},
"versionTimestamp": {
"description": "Milliseconds since epoch. Pass back as `versionTimestamp` on subsequent edit/update calls for optimistic locking.",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Insert (or re-render in place) a real DIAGRAM (BPMN, Diagrams-as-Code / any DSL: mermaid, d2, plantuml, graphviz, …) on a whiteboard as an editable SB diagram element. Provide documentId, diagramType (call listDiagramTypes / getDiagramTypeGuide), and source (the DSL). The diagram is rendered to an image stored like a pasted image, and its editable source is kept in a sidecar so it stays a live, re-openable diagram (double-click on the canvas opens the BPMN / code / AI editor). Options: caption (label beneath it), width/height to size it (auto width caps at 480px; an explicit width may go up to 1200px), and x/y or align ('left'|'center'|'right') to place it (defaults to the right of existing content). Pass updateElementId to UPDATE an existing embedded diagram in place — re-render + replace its image and DSL while keeping the same element id and board position (used to live-edit a diagram as it evolves); if that id is not on the board yet it is created carrying that id. After inserting, call getWhiteboardImage to see it and verify it rendered correctly (fix the source and re-insert if it is wrong). For a plain picture (not a diagram) use insertWhiteboardImage; to generate a diagram image WITHOUT inserting use renderDiagram.",
"inputSchema": {
"properties": {
"align": {
"description": "Horizontal alignment relative to existing content (placed below it). Ignored if x/y given.",
"enum": [
"left",
"center",
"right"
],
"type": "string"
},
"applyBrandTheme": {
"description": "Brand theming is ON BY DEFAULT: the board's effective BRAND KIT (colours only — typefaces are never injected) is baked into the diagram before it is rendered and its editable source stored (cascade: brandKitId override → project → workspace → org default → the built-in Stable Baseline theme). Set false to keep the library's stock styling. Themable types: mermaid, plantuml, graphviz, d2, systemsarchitecture, vega, vegalite, infographic; author theming in the DSL always wins.",
"type": "boolean"
},
"brandKitId": {
"description": "Optional brand kit UUID (see listBrandKits) to theme with instead of the cascade default. Must belong to your organisation.",
"type": "string"
},
"caption": {
"description": "Optional caption shown beneath the diagram.",
"type": "string"
},
"diagramType": {
"description": "Diagram language, e.g. 'default', 'bpmn', 'mermaid', 'd2', 'plantuml', 'graphviz'. For a diagram family, use its defaultRenderer from listDiagramTypes.",
"type": "string"
},
"documentId": {
"description": "The whiteboard's documentId.",
"type": "string"
},
"fit": {
"description": "When 'contain' AND both width and height are given, treat width/height as a BOUNDING BOX: the diagram is scaled to its natural aspect ratio to fit inside the box (never upscaled past 1.5x natural) and centred, so it never stretches. The response's diagram.{x,y,width,height} carry the final drawn geometry. Omit for the exact width/height behaviour.",
"enum": [
"contain"
],
"type": "string"
},
"height": {
"description": "Display height in px (defaults from width + aspect).",
"type": "number"
},
"source": {
"description": "The diagram DSL / code. For 'default', provide MDP JSON with stable IDs and omit entity x/y for automatic layout; fully positioned manual sources remain valid; icons must be exact iconKey values from listArchitectureIcons. For 'infographic', provide a plain-English description instead (the system designs the AntV infographic spec).",
"type": "string"
},
"updateElementId": {
"description": "Element id of an EXISTING embedded diagram to re-render and replace in place (keeps the element id + board position). Omit for a fresh insert. If the id is not on the board, a new element is created with it.",
"type": "string"
},
"width": {
"description": "Display width in px (aspect ratio preserved). Auto-size caps at 480px; an explicit width is honoured up to 1200px.",
"type": "number"
},
"x": {
"description": "Top-left x on the canvas. Omit to auto-place (or to keep the existing position when updateElementId is given).",
"type": "number"
},
"y": {
"description": "Top-left y on the canvas. Omit to auto-place (or to keep the existing position when updateElementId is given).",
"type": "number"
}
},
"required": [
"documentId",
"diagramType",
"source"
],
"type": "object"
},
"name": "insertWhiteboardDiagram",
"outputSchema": {
"type": "object"
}
},
{
"description": "Insert a real IMAGE (photo, screenshot, logo, picture) into a whiteboard — the storage-backed equivalent of insertImageInDocument. Provide the image as imageUrl (fetched and re-hosted), imageBase64, or imageBinary; for large files call createImageUploadSession(documentId) first then pass the returned assetUrl as imageUrl. The bytes are stored in the document-images bucket and the scene only holds a reference (never base64), exactly like pasted images. Options: caption (a text label placed + grouped beneath the image), width/height in px to RESIZE (if only one is given the other follows a 4:3 ratio; ~360px wide if neither), and placement via x/y (top-left) OR align ('left'|'center'|'right', positioned just below existing content) — omit both to auto-place to the right of the current content. After inserting, call getWhiteboardImage to verify. To move or resize the image later, patch its element via updateWhiteboardScene (mode:'patch' with {id, x, y, width, height}). For curated software-architecture ICONS (AWS/Docker/etc.) use addWhiteboardElements with an {type:'image', iconPath} spec instead.",
"inputSchema": {
"properties": {
"align": {
"description": "Horizontal alignment relative to existing content (placed below it). Ignored if x/y are provided.",
"enum": [
"left",
"center",
"right"
],
"type": "string"
},
"caption": {
"description": "Optional caption shown as a text label grouped beneath the image.",
"type": "string"
},
"customData": {
"additionalProperties": true,
"description": "Arbitrary Excalidraw customData stored on the element (e.g. { deckId } so a board image resolves back to its source deck). Merged with any builder-set customData.",
"type": "object"
},
"documentId": {
"description": "The whiteboard's documentId.",
"type": "string"
},
"fileName": {
"description": "Optional original filename (for storage + type hinting).",
"type": "string"
},
"height": {
"description": "Display height in px. Derived from width at 4:3 if omitted.",
"type": "number"
},
"imageBase64": {
"contentEncoding": "base64",
"description": "Base64-encoded image bytes (a data: URL prefix is allowed). Best for small images.",
"type": "string"
},
"imageBinary": {
"description": "Raw image bytes as an array of 0-255 values (alternative to imageBase64).",
"items": {
"type": "number"
},
"type": "array"
},
"imageUrl": {
"description": "URL to fetch the image from, or an assetUrl returned by createImageUploadSession.",
"type": "string"
},
"locked": {
"description": "Lock the placed image so it cannot be moved, resized, or deleted by hand (e.g. a deck-owned framed slide image that changes only via the deck conversation). Defaults to false.",
"type": "boolean"
},
"nlDescription": {
"description": "Optional plain-language description of the image, stored on the element for accessibility and so agents reading the board later know what it depicts.",
"type": "string"
},
"width": {
"description": "Display width in px (resize). Defaults to ~360.",
"type": "number"
},
"x": {
"description": "Top-left x on the canvas. Omit to auto-place.",
"type": "number"
},
"y": {
"description": "Top-left y on the canvas. Omit to auto-place.",
"type": "number"
}
},
"required": [
"documentId"
],
"type": "object"
},
"name": "insertWhiteboardImage",
"outputSchema": {
"type": "object"
}
},
{
"description": "Invite a person by email to the credential's organisation. Auth: org id must match the credential AND credential must hold can_manage_members. Rate limit 10/h. Returns invitation_id, expiry, and a seat-billing-impact summary. Email-existence is opaque: the response shape never reveals whether the email is already a member, already invited, or new. Use when the user asks to invite a teammate, friend, colleague, or new user to their organisation, or to onboard someone.",
"inputSchema": {
"properties": {
"email": {
"description": "Email address. Lowercased and trimmed. Max 320 chars.",
"type": "string"
},
"message": {
"description": "Optional personal message attached to the invitation email.",
"maxLength": 500,
"type": "string"
},
"organisation_id": {
"description": "Organisation UUID. Must match the credential's organisation.",
"type": "string"
},
"organization_role": {
"default": "member",
"description": "Role to grant on accept. 'owner' is never assignable via MCP.",
"enum": [
"member",
"admin"
],
"type": "string"
}
},
"required": [
"organisation_id",
"email",
"organization_role"
],
"type": "object"
},
"name": "inviteMember",
"outputSchema": {
"properties": {
"expires_at": {
"type": "string"
},
"invitation_id": {
"type": "string"
}
},
"type": "object"
}
},
{
"description": "Linked-mentions rail: every edge whose dst matches the named entity.",
"inputSchema": {
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"name": "kg_backlinks",
"outputSchema": {
"properties": {
"backlinks": {
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
{
"description": "Phase 5 / E3 — Provenance-aware assessor for a set of chunk_ids returned by kg_search. Returns per-chunk bucket (authored-grounded | extracted-high-conf | extracted-low-conf | no-support), overall distribution, dominant_bucket, and recommend_refusal. Pure metadata read - no LLM cost. Used by the agent's response policy to decide whether to answer confidently, caveat, or refuse.",
"inputSchema": {
"properties": {
"chunkIds": {
"description": "Array of kg_chunks.id values to assess.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"chunkIds"
],
"type": "object"
},
"name": "kg_evaluate_retrieval",
"outputSchema": {
"properties": {
"buckets": {
"type": "object"
},
"distribution": {
"type": "object"
},
"summary": {
"type": "string"
}
},
"type": "object"
}
},
{
"description": "Fetch a KG entity by id or name, with 1-hop neighbours. The response also carries `datedFacts`: what holds now about the entity by default, what held on a day with asOf, or the whole history with history:true, each fact with its dates, how it ended if it has, and the sources that state it.",
"inputSchema": {
"properties": {
"asOf": {
"description": "Dated facts: return what held on this day (YYYY-MM-DD) instead of what holds now. For example the owner, status or supplier as it was on a past date.",
"type": "string"
},
"entityId": {
"type": "string"
},
"history": {
"description": "Dated facts: return every fact with its dates, including facts that have ended (and how they ended) and planned ones, oldest first. Use for \"how did X change\" or \"what was X before\".",
"type": "boolean"
},
"name": {
"type": "string"
},
"projectId": {
"description": "Scope the lookup to one project. Recommended when resolving by `name`, since the same entity name can exist in several projects.",
"type": "string"
},
"timeZone": {
"description": "Dated facts: the IANA time zone to give days in (for example Australia/Sydney, Asia/Kolkata, America/New_York). Defaults to the user's saved time zone, else UTC.",
"type": "string"
}
},
"type": "object"
},
"name": "kg_get_entity",
"outputSchema": {
"properties": {
"entity": {
"type": "object"
}
},
"type": "object"
}
},
{
"description": "Fetch a community wiki page (LLM-curated CDMD).",
"inputSchema": {
"properties": {
"communityId": {
"type": "string"
},
"slug": {
"type": "string"
}
},
"type": "object"
},
"name": "kg_get_wiki_page",
"outputSchema": {
"properties": {
"community_id": {
"type": "string"
},
"page": {
"type": "object"
}
},
"type": "object"
}
},
{
"description": "List Louvain communities for an org (optionally scoped by project).",
"inputSchema": {
"properties": {
"level": {
"default": 0,
"type": "number"
},
"projectId": {
"type": "string"
}
},
"type": "object"
},
"name": "kg_list_communities",
"outputSchema": {
"properties": {
"communities": {
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
{
"description": "Find other sources that share entities with the given source.",
"inputSchema": {
"properties": {
"limit": {
"default": 10,
"type": "number"
},
"sourceId": {
"type": "string"
},
"sourceType": {
"enum": [
"document",
"diagram",
"improvement",
"plan",
"task"
],
"type": "string"
}
},
"required": [
"sourceType",
"sourceId"
],
"type": "object"
},
"name": "kg_related_documents",
"outputSchema": {
"properties": {
"documents": {
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
{
"description": "Check whether Knowledge Graph is in-scope for a given target.",
"inputSchema": {
"properties": {
"documentId": {
"type": "string"
},
"folderId": {
"type": "string"
},
"projectId": {
"type": "string"
},
"workspaceId": {
"type": "string"
}
},
"type": "object"
},
"name": "kg_scope_status",
"outputSchema": {
"properties": {
"organisation_scope": {
"type": "object"
},
"project_scopes": {
"type": "array"
},
"workspace_scopes": {
"type": "array"
}
},
"type": "object"
}
},
{
"description": "Unified Knowledge Graph KNOWLEDGE retrieval — facts, themes and relationships from INSIDE document CONTENT. To LOCATE AN ARTEFACT BY NAME OR ID rather than answer a question, pass artefactMetadataOnly:true — see below. Without that flag this tool retrieves knowledge from inside content and will not reliably find a thing by its title.\n\nDATED FACTS: the response also carries `datedFacts` for the entities the query names: what holds now by default, what held on a day with asOf, or the whole history with history:true, each fact with its dates, how it ended if it has, and its sources. Prefer them for \"who owns X now\", \"what was X in March\", \"when did X change\".\n\nPICK THE MODE THAT FITS THE QUERY:\n\n• mode='local' (default) — for SPECIFIC factual questions (\"what does section 15 say about deposits?\", \"who is the Chief Counsel?\"). FTS+vector RRF over individual document chunks. Returns precise excerpts with citations.\n\n• mode='global' — for THEMATIC / OVERVIEW / SUMMARY questions (\"what are the main themes\", \"give me an overview of the project\", \"what topics does this cover\"). Returns Louvain community summaries + curated wiki pages — far better than 'local' for big-picture queries because community summaries already aggregate across many chunks. ALWAYS PREFER over 'local' when the user asks for themes / summary / overview / topic landscape.\n\n• mode='graph' — for RELATIONSHIP questions (\"what's connected to entity X?\", \"who cites Section 5?\"). 1-hop entity-neighbourhood walk. Pass query OR srcEntityId.\n\n• mode='path' — for CONNECTION questions (\"how does X relate to Y?\"). Shortest path between two entities. Pass srcEntityId AND dstEntityId.\n\n• mode='ppr' — for MULTI-HOP discovery (\"what's relevant to X, even indirectly?\"). Personalised PageRank over AUTHORED-vs-EXTRACTED weighted edges, seeded by query-similar entities. Best when 'local' returns too few results and the answer requires walking through several entity hops.\n\nQuick decision tree:\n- User asks for an overview/summary/themes → 'global'\n- User asks a specific question with a clear answer → 'local'\n- User asks 'how is X connected to Y' → 'path' (with both entity IDs)\n- User asks 'what's near entity X' → 'graph' (with srcEntityId)\n- 'local' returned nothing useful and the question is broad → retry with 'ppr'\n- User wants to FIND a named artefact (\"the GTM plan\", \"DOC-123\", a uuid) → artefactMetadataOnly:true\n\nARTEFACT-METADATA MODE (artefactMetadataOnly:true): ignores `mode` entirely and matches title + friendly id + uuid across EVERY artefact type — documents, whiteboards, plans, tasks, improvements, compliance frameworks. Returns a typed navigable list ({ artefacts: [{ result_type, id, friendly_id, title, snippet, document_id, project_id, href }] }). It reads no document content and needs no knowledge graph: unlike every other mode it is NOT limited to what has been ingested, so it still finds artefacts in projects where the KG is switched off. Narrow it with artefactTypes. To search inside document BODIES use listDocuments (full-content grep).",
"inputSchema": {
"properties": {
"artefactMetadataOnly": {
"default": false,
"description": "Find artefacts BY NAME/ID instead of retrieving knowledge. Matches title + friendly id + uuid only — never document content — across all artefact types, and does not require the knowledge graph to be enabled. Default false.",
"type": "boolean"
},
"artefactTypes": {
"description": "Only with artefactMetadataOnly:true. Restrict the search to these artefact types. Omit to search all of them. Unknown values are rejected rather than ignored.",
"items": {
"enum": [
"document",
"whiteboard",
"improvement",
"task",
"plan",
"compliance"
],
"type": "string"
},
"type": "array"
},
"asOf": {
"description": "Dated facts: return what held on this day (YYYY-MM-DD) instead of what holds now. For example the owner, status or supplier as it was on a past date.",
"type": "string"
},
"depth": {
"default": 2,
"description": "Hop depth for graph/path modes.",
"type": "number"
},
"dstEntityId": {
"description": "Required for mode='path'. Target entity to find a path TO.",
"type": "string"
},
"history": {
"description": "Dated facts: return every fact with its dates, including facts that have ended (and how they ended) and planned ones, oldest first. Use for \"how did X change\" or \"what was X before\".",
"type": "boolean"
},
"limit": {
"default": 20,
"type": "number"
},
"mode": {
"default": "local",
"description": "Retrieval strategy. See tool description for when to use each — strongly prefer 'global' for thematic/overview questions.",
"enum": [
"local",
"global",
"graph",
"path",
"ppr"
],
"type": "string"
},
"offset": {
"description": "Only with artefactMetadataOnly:true. Skip this many results for paging.",
"type": "number"
},
"projectId": {
"description": "STRONGLY RECOMMENDED — in practice required. The KG is scoped per project/workspace and there is usually no organisation-wide default, so a call with no projectId and no workspaceId typically matches no scope rule and returns nothing useful. Use listProjects to find the id.",
"type": "string"
},
"query": {
"description": "Natural-language query. Required for local/global/ppr; optional for graph (use srcEntityId instead). With artefactMetadataOnly:true this is the artefact name, friendly id or uuid to find.",
"type": "string"
},
"srcEntityId": {
"description": "Required for mode='path'. Optional source entity for mode='graph'.",
"type": "string"
},
"timeZone": {
"description": "Dated facts: the IANA time zone to give days in (for example Australia/Sydney, Asia/Kolkata, America/New_York). Defaults to the user's saved time zone, else UTC. Pass the user's zone when you know it, so \"today\" and dates match their calendar.",
"type": "string"
},
"workspaceId": {
"description": "Alternative to projectId — searches the whole workspace subtree. Give one of the two.",
"type": "string"
}
},
"type": "object"
},
"name": "kg_search",
"outputSchema": {
"properties": {
"chunks": {
"description": "Hybrid-retrieved chunks with grounding-aware reranker scores.",
"items": {
"type": "object"
},
"type": "array"
},
"mode": {
"enum": [
"local",
"global",
"ppr"
],
"type": "string"
},
"ok": {
"type": "boolean"
},
"query": {
"type": "string"
},
"reason": {
"description": "Set when scope_disabled — KG not enabled or out of scope.",
"type": "string"
},
"scope": {
"type": "object"
}
},
"type": "object"
}
},
{
"description": "3 template + 3 LLM-generated sample questions for the knowledge-graph playground.",
"inputSchema": {
"properties": {
"projectId": {
"type": "string"
}
},
"type": "object"
},
"name": "kg_suggest_sample_questions",
"outputSchema": {
"properties": {
"questions": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
},
{
"description": "List and search the full Stable Baseline icon library, including 3,850 library icons. The AWS, Azure, GCP, Development, Essentials and other categories stay intact; library icons join matching categories, with specific Oracle Cloud, Kubernetes, Networking and General categories for the rest. The same logical name is shown once. iconKey is the exact icon string for a platform default diagram (type 'default'; e.g. {icon:'aws-account'}); iconKeys lists every exact key for that logical icon, and iconKeyUrl is its SVG. Results without an iconKey are not available in platform default diagrams. Use d2IconPath for compact relative D2 source (e.g. icon-library/azure-function-apps.svg); the renderer expands storage URLs. Existing iconPath values remain relative whiteboard paths; library-only icons supply iconUrl for a whiteboard imageUrl.",
"inputSchema": {
"properties": {
"category": {
"description": "Filter by category, e.g. AWS, Azure, GCP, Technology, Oracle Cloud, Kubernetes, Networking, General.",
"type": "string"
},
"fields": {
"description": "Field projection. Valid fields: id, iconPath (existing relative paths only), iconUrl, iconName, category, categories, sources, iconKey, iconKeys, iconKeyUrl, d2IconPath, subcategory, vendor, description, searchTerms, tags, useCases, aliases, isFeatured, displayOrder.",
"items": {
"type": "string"
},
"type": "array"
},
"limit": {
"type": "number"
},
"offset": {
"type": "number"
},
"query": {
"description": "Search by icon name, exact iconKey, category, vendor, description or aliases.",
"type": "string"
}
},
"type": "object"
},
"name": "listArchitectureIcons",
"outputSchema": {
"properties": {
"hasMore": {
"description": "True if more rows are available beyond the returned page.",
"type": "boolean"
},
"icons": {
"description": "Page of icons.",
"items": {
"type": "object"
},
"type": "array"
},
"nextOffset": {
"description": "Pass as `offset` on the next call to continue paging.",
"type": "number"
},
"totalCount": {
"description": "Total matching rows (when the data source provides it).",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Server-side searchable, paginated list of USERS and TEAMS that can be assigned as the owner of an improvement/task in a project — and the canonical source for resolving a person's user_id when @-mentioning them in a document. Returns two arrays — `users` (with user_id, display_name, email, avatar_url, has_explicit_permission) and `teams` (with team_id, name, member_count, has_explicit_permission). Sources: project-level grants + workspace members + organization members + members of teams granted access. Use BEFORE: (1) updateImprovement/updateTask when you need an `owner_id` (kind='user') or `owner_team_id` (kind='team'); (2) inserting a `<!-- REFERENCE: {\"type\":\"user\",\"id\":\"…\",\"label\":\"…\"} -->` mention in document content via createDocument / editDocument / findAndReplaceTextInDocument. Supports `q` for ILIKE search on names/emails (users) or team names. Pass `kind='user'` or `kind='team'` to scope to a single section, or 'all' (default) for both. Pagination via limit (1-100, default 20) + offset.",
"inputSchema": {
"properties": {
"kind": {
"description": "Filter to one principal kind. Default 'all' returns users first then teams.",
"enum": [
"all",
"user",
"team"
],
"type": "string"
},
"limit": {
"description": "Max results per page (1-100, default 20).",
"type": "number"
},
"offset": {
"description": "Pagination offset.",
"type": "number"
},
"projectId": {
"description": "Project to scope assignees to. Required.",
"type": "string"
},
"q": {
"description": "Deprecated alias for `query`, still accepted. Prefer `query` — that is the name every other list tool uses.",
"type": "string"
},
"query": {
"description": "Optional ILIKE search filter — matched against display_name + email (users) and team name (teams).",
"type": "string"
},
"workspaceId": {
"description": "Workspace UUID. Optional but recommended — when present, the result includes ALL org members; when omitted, only direct project grants + team-expanded users are returned.",
"type": "string"
}
},
"required": [
"projectId"
],
"type": "object"
},
"name": "listAssignablePrincipals",
"outputSchema": {
"properties": {
"teams": {
"items": {
"type": "object"
},
"type": "array"
},
"users": {
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
{
"description": "List an organisation's BRAND KITS (palette/fonts/logo), newest first. Use a returned `id` as brandKitId for a design call or setDefaultBrandKit. Auth: can_admin_org.",
"inputSchema": {
"properties": {
"organizationId": {
"type": "string"
}
},
"required": [
"organizationId"
],
"type": "object"
},
"name": "listBrandKits",
"outputSchema": {
"properties": {
"hasMore": {
"description": "True if more rows are available beyond the returned page.",
"type": "boolean"
},
"items": {
"items": {
"type": "object"
},
"type": "array"
},
"nextOffset": {
"description": "Pass as `offset` on the next call to continue paging.",
"type": "number"
},
"totalCount": {
"description": "Total matching rows (when the data source provides it).",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "List credit-purchase history for an organisation, newest first. Status, credits purchased, bonus, amount paid in AUD cents, completion timestamp. Stripe IDs stripped.",
"inputSchema": {
"properties": {
"limit": {
"description": "Max rows (default 50, max 200).",
"type": "number"
},
"offset": {
"description": "Pagination offset (default 0).",
"type": "number"
},
"organisation_id": {
"description": "UUID of the organisation. Must match the credential's organisation.",
"type": "string"
}
},
"required": [
"organisation_id"
],
"type": "object"
},
"name": "listCreditPurchases",
"outputSchema": {
"properties": {
"hasMore": {
"description": "True if more rows are available beyond the returned page.",
"type": "boolean"
},
"nextOffset": {
"description": "Pass as `offset` on the next call to continue paging.",
"type": "number"
},
"purchases": {
"description": "Page of purchases.",
"items": {
"type": "object"
},
"type": "array"
},
"totalCount": {
"description": "Total matching rows (when the data source provides it).",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "List supported diagram types (renderers such as default, mermaid, plantuml, bpmn and d2; 'default' is the platform default renderer). Pass `query` to search by name OR intent (keyword + semantic): e.g. 'circuit diagram', 'wiring harness', 'timing waveform', 'network topology', 'database schema', 'BPMN process'. Each type lists supportedDiagrams: the diagram families it draws (BPMN process, ERD, flowchart, C4, system architecture and more), each with its defaultRenderer. A query that names a family also returns matchedDiagramFamilies. Use a family's defaultRenderer as the type unless you need another renderer's own format (for example BPMN 2.0 XML). Use the returned `type` field with getDiagramTypeGuide (DSL instructions + example) and insertDiagramInDocument / renderDiagram.",
"inputSchema": {
"properties": {
"enabledOnly": {
"type": "boolean"
},
"fields": {
"description": "Field projection. Valid fields: type, label, description, whenToUse, dslLanguage, dslInstructions, exampleDsl, enabled, availableOnFree, sortOrder, updatedAt, supportedDiagrams.",
"items": {
"type": "string"
},
"type": "array"
},
"limit": {
"type": "number"
},
"offset": {
"type": "number"
},
"query": {
"description": "Keyword or intent, e.g. 'circuit', 'wiring harness', 'timing', 'BPMN process'. Semantic-backed: matches descriptions and diagram family names, not just type names.",
"type": "string"
}
},
"type": "object"
},
"name": "listDiagramTypes",
"outputSchema": {
"properties": {
"diagramTypes": {
"description": "Diagram types (renderers). Each lists supportedDiagrams: the families it draws, each with its defaultRenderer.",
"items": {
"type": "object"
},
"type": "array"
},
"matchedDiagramFamilies": {
"description": "When the query names a diagram family: the family, its defaultRenderer and all its renderers.",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
{
"description": "List version history for a document. Returns timestamps, creator, change summary, and content.",
"inputSchema": {
"properties": {
"documentId": {
"description": "Accepts either the UUID or the friendly id (e.g. DOC-815); friendly ids are resolved within your organisation.",
"type": "string"
},
"fields": {
"description": "Field projection. Valid fields: id, documentId, versionNumber, title, contentMarkdown, changeSummary, createdBy, createdAt.",
"items": {
"type": "string"
},
"type": "array"
},
"fromDate": {
"description": "ISO 8601 date filter (from).",
"type": "string"
},
"limit": {
"description": "Max versions. Default: 50, max: 200.",
"type": "number"
},
"offset": {
"description": "Pagination offset.",
"type": "number"
},
"projectId": {
"description": "Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID.",
"type": "string"
},
"sortAscending": {
"description": "Sort oldest first. Default: false.",
"type": "boolean"
},
"toDate": {
"description": "ISO 8601 date filter (to).",
"type": "string"
},
"versionNumber": {
"description": "Filter to a specific version.",
"type": "number"
}
},
"required": [
"documentId"
],
"type": "object"
},
"name": "listDocumentVersions",
"outputSchema": {
"properties": {
"hasMore": {
"description": "True if more rows are available beyond the returned page.",
"type": "boolean"
},
"nextOffset": {
"description": "Pass as `offset` on the next call to continue paging.",
"type": "number"
},
"totalCount": {
"description": "Total matching rows (when the data source provides it).",
"type": "number"
},
"versions": {
"description": "Page of versions.",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
{
"description": "List AND grep documents in a project, workspace, or folder. `query` does a full-content search across each document's body (not just the title) and returns the matching lines — like grep across your docs. Each returned document includes `contentMatches: [{line, text, context?}]` and `matchCount`; the `text` is anchor-ready (paste it straight into editDocument's oldText). Use isRegex:true for regular-expression search (e.g. \"TODO\\(.*\\)\", \"ACME-\\d+\"), caseSensitive for exact case, and contextLines for surrounding lines (grep -C). versionTimestamp is returned per document so you can edit straight from the results without a getDocument round-trip. Also supports date filtering. SCOPE HONESTY — read this before concluding something is absent: only documents that actually matched are returned (a document is never listed with matchCount 0 just because it was in scope), and the `grep` block reports `scannedDocuments` against `totalDocumentsInScope`. When `truncated` is true the search covered only part of the scope, so an absence is NOT proof; repeat with `scanOffset` set to the returned `nextScanOffset` until that field is gone, and union the results. A document too large to read is returned with `contentSearchSkipped: true` and NO matchCount, because its body was never searched.",
"inputSchema": {
"properties": {
"caseSensitive": {
"description": "Case-sensitive matching. Default false.",
"type": "boolean"
},
"contextLines": {
"description": "Lines of surrounding context to include with each match (grep -C). 0-5, default 0.",
"type": "number"
},
"dateField": {
"description": "Date field to filter. Default: updated_at.",
"type": "string"
},
"fields": {
"description": "Field projection for the document metadata. Valid fields: id, title, friendlyId, friendlyIdNumber, projectId, folderId, createdAt, updatedAt, href. (contentMatches/matchCount are always included when query is set.)",
"items": {
"type": "string"
},
"type": "array"
},
"folderId": {
"type": "string"
},
"fromDate": {
"description": "ISO 8601 date filter (from).",
"type": "string"
},
"isRegex": {
"description": "Treat `query` as a JavaScript regular expression (grep -E). Default false (literal substring). Regex search requires a project/workspace/folder scope and scans a bounded window of documents.",
"type": "boolean"
},
"limit": {
"type": "number"
},
"maxMatchesPerDocument": {
"description": "Cap on matching lines returned per document. 1-20, default 5.",
"type": "number"
},
"offset": {
"description": "Pagination offset over the MATCHES. When searching, use scanOffset (not this) to reach documents the scan has not covered.",
"type": "number"
},
"projectId": {
"type": "string"
},
"query": {
"description": "Search text. Matched against title, friendlyId AND full document content. Returns the matching lines per document (grep). Case-insensitive unless caseSensitive:true; treated as a regex if isRegex:true.",
"type": "string"
},
"scanOffset": {
"description": "Search-only. Where to start the document scan within the scope. One call examines a bounded window; when the response reports truncated:true it also returns nextScanOffset — repeat with scanOffset set to that value until nextScanOffset is absent, and union the results, to search a scope larger than one window exhaustively.",
"type": "number"
},
"toDate": {
"description": "ISO 8601 date filter (to).",
"type": "string"
},
"workspaceId": {
"type": "string"
}
},
"type": "object"
},
"name": "listDocuments",
"outputSchema": {
"properties": {
"documents": {
"description": "Page of documents.",
"items": {
"type": "object"
},
"type": "array"
},
"hasMore": {
"description": "True if more rows are available beyond the returned page.",
"type": "boolean"
},
"nextOffset": {
"description": "Pass as `offset` on the next call to continue paging.",
"type": "number"
},
"totalCount": {
"description": "Total matching rows (when the data source provides it).",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "List folders in a project. Use parentId for nested folders. For full tree, use getProjectHierarchy instead.",
"inputSchema": {
"properties": {
"dateField": {
"description": "Date field to filter. Default: updated_at.",
"type": "string"
},
"fields": {
"description": "Field projection. Valid fields: id, projectId, parentId, name, position, createdAt, updatedAt.",
"items": {
"type": "string"
},
"type": "array"
},
"fromDate": {
"description": "ISO 8601 date filter (from).",
"type": "string"
},
"limit": {
"type": "number"
},
"offset": {
"type": "number"
},
"parentId": {
"type": "string"
},
"projectId": {
"type": "string"
},
"query": {
"type": "string"
},
"toDate": {
"description": "ISO 8601 date filter (to).",
"type": "string"
}
},
"required": [
"projectId"
],
"type": "object"
},
"name": "listFolders",
"outputSchema": {
"properties": {
"folders": {
"description": "Page of folders.",
"items": {
"type": "object"
},
"type": "array"
},
"hasMore": {
"description": "True if more rows are available beyond the returned page.",
"type": "boolean"
},
"nextOffset": {
"description": "Pass as `offset` on the next call to continue paging.",
"type": "number"
},
"totalCount": {
"description": "Total matching rows (when the data source provides it).",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "List improvement categories for a project. Returns tree and flat list.",
"inputSchema": {
"properties": {
"projectId": {
"type": "string"
}
},
"required": [
"projectId"
],
"type": "object"
},
"name": "listImprovementCategories",
"outputSchema": {
"properties": {
"categories": {
"description": "Page of categories.",
"items": {
"type": "object"
},
"type": "array"
},
"hasMore": {
"description": "True if more rows are available beyond the returned page.",
"type": "boolean"
},
"nextOffset": {
"description": "Pass as `offset` on the next call to continue paging.",
"type": "number"
},
"totalCount": {
"description": "Total matching rows (when the data source provides it).",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "List AND grep improvements in a project. `query` searches the title, friendlyId and problem statement, not just the title (substring by default; set isRegex:true for a regular expression, caseSensitive:true for exact case). Supports filtering by status, type, priority, and by parentItemId for an item's children in the work hierarchy (an epic's stories, say). For ranked semantic + text search use searchImprovements. Every item carries its versionTimestamp, ready for updateImprovement, so one call here supplies the tokens for a whole batch of updates (fields [\"id\", \"friendlyId\", \"versionTimestamp\"] returns just those), and its parentItem: the item it belongs to in the work hierarchy ({ id, friendlyId, title, type, status, isTask }, or null).",
"inputSchema": {
"properties": {
"agentReady": {
"description": "Filter by agent readiness.",
"type": "boolean"
},
"caseSensitive": {
"description": "Case-sensitive matching. Default false.",
"type": "boolean"
},
"categoryId": {
"description": "Filter by category ID.",
"type": "string"
},
"complianceOnly": {
"description": "Only compliance-linked improvements.",
"type": "boolean"
},
"fields": {
"description": "Field projection. Valid fields: id, friendly_id, friendlyId, title, type, status, priority, source, category_id, categoryId, parent_item_id, parentItemId, parentItem, created_at, createdAt, updated_at, updatedAt, versionTimestamp, href.",
"items": {
"type": "string"
},
"type": "array"
},
"frameworkKey": {
"description": "Filter by framework (e.g. soc2, iso27001).",
"type": "string"
},
"isRegex": {
"description": "Treat query as a regular expression (grep -E), e.g. \"ACME-\\d+\". Default false (literal substring).",
"type": "boolean"
},
"limit": {
"description": "Max results (1-100, default 50).",
"type": "number"
},
"offset": {
"description": "Pagination offset.",
"type": "number"
},
"parentItemId": {
"description": "Only the children of this item in the work hierarchy (its UUID or friendly id, such as IMP-12), whatever plan or phase they are in. \"none\" lists only the items with no parent. The work hierarchy is not the plan outline nesting (setPlanItemParent).",
"maxLength": 64,
"type": "string"
},
"priority": {
"description": "Filter: low, medium, high, critical.",
"type": "string"
},
"projectId": {
"type": "string"
},
"query": {
"description": "Grep across title, friendlyId and problem_statement. Substring by default; a regular expression when isRegex:true; case-insensitive unless caseSensitive:true.",
"type": "string"
},
"scanRunId": {
"description": "Filter by compliance scan run.",
"type": "string"
},
"sortAscending": {
"description": "Sort ascending. Default: true.",
"type": "boolean"
},
"sortField": {
"description": "Sort field. Default: position.",
"type": "string"
},
"source": {
"description": "Filter by source: human_manual, agent_review, doc_comment, feedback, incident, postmortem, code_review, imported. agent_review is the Compliance view; 'other' is every source except agent_review (the General view).",
"type": "string"
},
"status": {
"description": "Filter: captured, triaging, shaped, approved, ready_for_agent, in_progress, ready_for_review, in_review, blocked, done, rejected, deferred.",
"type": "string"
},
"type": {
"description": "Filter by type: feature, enhancement, bug, tech_debt, architecture_gap, documentation_gap, risk, epic, user_story, requirement, test_case, spike, task. Tasks (is_task=true) always have type='task'.",
"type": "string"
}
},
"required": [
"projectId"
],
"type": "object"
},
"name": "listImprovements",
"outputSchema": {
"properties": {
"hasMore": {
"description": "True if more rows are available beyond the returned page.",
"type": "boolean"
},
"improvements": {
"description": "Page of improvements.",
"items": {
"type": "object"
},
"type": "array"
},
"nextOffset": {
"description": "Pass as `offset` on the next call to continue paging.",
"type": "number"
},
"totalCount": {
"description": "Total matching rows (when the data source provides it).",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "List organisation invitations. Auth: org id must match the credential's organisation AND the credential must hold the can_manage_members capability. Status defaults to 'pending'. Pass 'all' to disable filtering.",
"inputSchema": {
"properties": {
"limit": {
"default": 50,
"maximum": 200,
"minimum": 1,
"type": "number"
},
"offset": {
"default": 0,
"minimum": 0,
"type": "number"
},
"organisation_id": {
"description": "Organisation UUID. Must match the credential's organisation.",
"type": "string"
},
"status": {
"default": "pending",
"enum": [
"pending",
"accepted",
"expired",
"declined",
"revoked",
"all"
],
"type": "string"
}
},
"required": [
"organisation_id"
],
"type": "object"
},
"name": "listInvitations",
"outputSchema": {
"properties": {
"hasMore": {
"description": "True if more rows are available beyond the returned page.",
"type": "boolean"
},
"invitations": {
"description": "Page of invitations.",
"items": {
"type": "object"
},
"type": "array"
},
"nextOffset": {
"description": "Pass as `offset` on the next call to continue paging.",
"type": "number"
},
"totalCount": {
"description": "Total matching rows (when the data source provides it).",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "List invoices for an organisation, newest first. Returns hosted Stripe invoice URLs and PDF links. Stripe IDs are stripped.",
"inputSchema": {
"properties": {
"limit": {
"description": "Max rows (default 50, max 200).",
"type": "number"
},
"offset": {
"description": "Pagination offset (default 0).",
"type": "number"
},
"organisation_id": {
"description": "UUID of the organisation. Must match the credential's organisation.",
"type": "string"
}
},
"required": [
"organisation_id"
],
"type": "object"
},
"name": "listInvoices",
"outputSchema": {
"properties": {
"hasMore": {
"description": "True if more rows are available beyond the returned page.",
"type": "boolean"
},
"invoices": {
"description": "Page of invoices.",
"items": {
"type": "object"
},
"type": "array"
},
"nextOffset": {
"description": "Pass as `offset` on the next call to continue paging.",
"type": "number"
},
"totalCount": {
"description": "Total matching rows (when the data source provides it).",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "List members of an organisation, enriched with email + display name. Auth: org id must match the credential's organisation. Returns paginated list, default limit 50 / max 200.",
"inputSchema": {
"properties": {
"include_invited": {
"default": false,
"description": "When true, include rows that haven't joined yet (joined_at IS NULL).",
"type": "boolean"
},
"limit": {
"default": 50,
"maximum": 200,
"minimum": 1,
"type": "number"
},
"offset": {
"default": 0,
"minimum": 0,
"type": "number"
},
"organisation_id": {
"description": "Organisation UUID. Must match the credential's organisation.",
"type": "string"
}
},
"required": [
"organisation_id"
],
"type": "object"
},
"name": "listMembers",
"outputSchema": {
"properties": {
"hasMore": {
"description": "True if more rows are available beyond the returned page.",
"type": "boolean"
},
"members": {
"description": "Page of members.",
"items": {
"type": "object"
},
"type": "array"
},
"nextOffset": {
"description": "Pass as `offset` on the next call to continue paging.",
"type": "number"
},
"totalCount": {
"description": "Total matching rows (when the data source provides it).",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "List organisations you have access to. Supports query filtering by name/slug.",
"inputSchema": {
"properties": {
"fields": {
"description": "Field projection. Valid fields: id, name, slug, subscription_tier, created_at.",
"items": {
"type": "string"
},
"type": "array"
},
"limit": {
"type": "number"
},
"offset": {
"type": "number"
},
"query": {
"type": "string"
}
},
"type": "object"
},
"name": "listOrganisations",
"outputSchema": {
"properties": {
"hasMore": {
"description": "True if more rows are available beyond the returned page.",
"type": "boolean"
},
"nextOffset": {
"description": "Pass as `offset` on the next call to continue paging.",
"type": "number"
},
"organisations": {
"description": "Page of organisations.",
"items": {
"type": "object"
},
"type": "array"
},
"totalCount": {
"description": "Total matching rows (when the data source provides it).",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "List saved payment methods for an organisation. Returns masked card metadata only (brand, last4, exp month/year, default flag). NEVER returns full card numbers, CVCs, or any Stripe IDs.",
"inputSchema": {
"properties": {
"organisation_id": {
"description": "UUID of the organisation. Must match the credential's organisation.",
"type": "string"
}
},
"required": [
"organisation_id"
],
"type": "object"
},
"name": "listPaymentMethods",
"outputSchema": {
"properties": {
"hasMore": {
"description": "True if more rows are available beyond the returned page.",
"type": "boolean"
},
"nextOffset": {
"description": "Pass as `offset` on the next call to continue paging.",
"type": "number"
},
"payment_methods": {
"description": "Page of payment_methods.",
"items": {
"type": "object"
},
"type": "array"
},
"totalCount": {
"description": "Total matching rows (when the data source provides it).",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "List phases for a plan ordered by position. Each phase carries its own versionTimestamp, ready for updatePlanPhase.",
"inputSchema": {
"properties": {
"planId": {
"type": "string"
}
},
"required": [
"planId"
],
"type": "object"
},
"name": "listPlanPhases",
"outputSchema": {
"properties": {
"hasMore": {
"description": "True if more rows are available beyond the returned page.",
"type": "boolean"
},
"nextOffset": {
"description": "Pass as `offset` on the next call to continue paging.",
"type": "number"
},
"phases": {
"description": "Page of phases.",
"items": {
"type": "object"
},
"type": "array"
},
"totalCount": {
"description": "Total matching rows (when the data source provides it).",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "List AND grep plans in a project. `query` searches the title, friendlyId and description, not just the title (substring by default; set isRegex:true for a regular expression, caseSensitive:true for exact case). Supports filtering by status and priority.",
"inputSchema": {
"properties": {
"caseSensitive": {
"description": "Case-sensitive matching. Default false.",
"type": "boolean"
},
"fields": {
"description": "Field projection. Valid fields: id, friendly_id, friendlyId, title, description, status, priority, icon, color, start_date, startDate, end_date, endDate, created_at, createdAt, updated_at, updatedAt, versionTimestamp, href.",
"items": {
"type": "string"
},
"type": "array"
},
"isRegex": {
"description": "Treat query as a regular expression (grep -E), e.g. \"ACME-\\d+\". Default false (literal substring).",
"type": "boolean"
},
"limit": {
"description": "Max results (1-100, default 50).",
"type": "number"
},
"offset": {
"description": "Pagination offset.",
"type": "number"
},
"priority": {
"description": "Filter: low, medium, high, critical.",
"type": "string"
},
"projectId": {
"type": "string"
},
"query": {
"description": "Grep across title, friendlyId and description. Substring by default; a regular expression when isRegex:true; case-insensitive unless caseSensitive:true.",
"type": "string"
},
"sortAscending": {
"description": "Sort ascending. Default: false.",
"type": "boolean"
},
"sortField": {
"description": "Sort field. Default: created_at.",
"type": "string"
},
"status": {
"description": "Filter: draft, planning, active, on_hold, completed, cancelled.",
"type": "string"
}
},
"required": [
"projectId"
],
"type": "object"
},
"name": "listPlans",
"outputSchema": {
"properties": {
"hasMore": {
"description": "True if more rows are available beyond the returned page.",
"type": "boolean"
},
"nextOffset": {
"description": "Pass as `offset` on the next call to continue paging.",
"type": "number"
},
"plans": {
"description": "Page of plans.",
"items": {
"type": "object"
},
"type": "array"
},
"totalCount": {
"description": "Total matching rows (when the data source provides it).",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "List projects in a workspace. Supports query filtering by project name.",
"inputSchema": {
"properties": {
"dateField": {
"description": "Date field to filter. Default: updated_at.",
"type": "string"
},
"fields": {
"description": "Field projection. Valid fields: id, name, description, workspace_id, created_at, updated_at.",
"items": {
"type": "string"
},
"type": "array"
},
"fromDate": {
"description": "ISO 8601 date filter (from).",
"type": "string"
},
"limit": {
"type": "number"
},
"offset": {
"type": "number"
},
"query": {
"type": "string"
},
"toDate": {
"description": "ISO 8601 date filter (to).",
"type": "string"
},
"workspaceId": {
"type": "string"
}
},
"required": [
"workspaceId"
],
"type": "object"
},
"name": "listProjects",
"outputSchema": {
"properties": {
"hasMore": {
"description": "True if more rows are available beyond the returned page.",
"type": "boolean"
},
"nextOffset": {
"description": "Pass as `offset` on the next call to continue paging.",
"type": "number"
},
"projects": {
"description": "Page of projects.",
"items": {
"type": "object"
},
"type": "array"
},
"totalCount": {
"description": "Total matching rows (when the data source provides it).",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "List explicit permission grants on a resource (workspace/project/folder/document/improvement/plan), including principal type (user|team), level (none|read|write|admin), and 3-state overrides for documents/improvements/plans. Read-only. Use when the user asks 'who can see this', 'who has access', 'what permissions are set on this', or to audit existing access on a resource.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"resource_id": {
"description": "UUID of the resource",
"type": "string"
},
"resource_type": {
"enum": [
"workspace",
"project",
"folder",
"document",
"improvement",
"plan"
],
"type": "string"
}
},
"required": [
"resource_type",
"resource_id"
],
"type": "object"
},
"name": "listResourcePermissions",
"outputSchema": {
"properties": {
"hasMore": {
"description": "True if more rows are available beyond the returned page.",
"type": "boolean"
},
"nextOffset": {
"description": "Pass as `offset` on the next call to continue paging.",
"type": "number"
},
"permissions": {
"description": "Page of permissions.",
"items": {
"type": "object"
},
"type": "array"
},
"totalCount": {
"description": "Total matching rows (when the data source provides it).",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "List FS/SS/FF task-dependency edges in a plan (the Gantt arrows). Scope by planId, projectId, or itemId. `direction`: 'predecessors' | 'successors' | 'both' (default, only with itemId).",
"inputSchema": {
"properties": {
"direction": {
"description": "Only meaningful with itemId. Default: both.",
"enum": [
"predecessors",
"successors",
"both"
],
"type": "string"
},
"itemId": {
"description": "Limit to one item's edges.",
"type": "string"
},
"planId": {
"description": "Limit to one plan.",
"type": "string"
},
"projectId": {
"description": "Limit to one project (all plans).",
"type": "string"
}
},
"type": "object"
},
"name": "listTaskDependencies",
"outputSchema": {
"properties": {
"dependencies": {
"description": "Page of dependencies.",
"items": {
"type": "object"
},
"type": "array"
},
"hasMore": {
"description": "True if more rows are available beyond the returned page.",
"type": "boolean"
},
"nextOffset": {
"description": "Pass as `offset` on the next call to continue paging.",
"type": "number"
},
"totalCount": {
"description": "Total matching rows (when the data source provides it).",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "List AND grep tasks in a plan. `query` searches the title, friendlyId and description, not just the title (substring by default; set isRegex:true for a regular expression, caseSensitive:true for exact case). Supports filtering by status, priority, phaseId and parentItemId (a story's tasks in the work hierarchy, say). Every task carries its versionTimestamp, ready for updateTask, so one call here supplies the tokens for a whole batch of updates, and its parent_item_id and parentItem (the item it belongs to in the work hierarchy, or null).",
"inputSchema": {
"properties": {
"caseSensitive": {
"description": "Case-sensitive matching. Default false.",
"type": "boolean"
},
"isRegex": {
"description": "Treat query as a regular expression (grep -E), e.g. \"ACME-\\d+\". Default false (literal substring).",
"type": "boolean"
},
"limit": {
"description": "Max results (1-100, default 50).",
"type": "number"
},
"offset": {
"description": "Pagination offset.",
"type": "number"
},
"parentItemId": {
"description": "Only the children of this item in the work hierarchy (its UUID or friendly id, such as IMP-12), whatever plan or phase they are in. \"none\" lists only the items with no parent. The work hierarchy is not the plan outline nesting (setPlanItemParent).",
"maxLength": 64,
"type": "string"
},
"phaseId": {
"description": "Filter by phase.",
"type": "string"
},
"planId": {
"type": "string"
},
"priority": {
"description": "Filter by priority.",
"type": "string"
},
"query": {
"description": "Grep across title, friendlyId and description. Substring by default; a regular expression when isRegex:true; case-insensitive unless caseSensitive:true.",
"type": "string"
},
"sortAscending": {
"description": "Sort ascending. Default: true.",
"type": "boolean"
},
"sortField": {
"description": "Sort field. Default: position.",
"type": "string"
},
"status": {
"description": "Filter by status.",
"type": "string"
}
},
"required": [
"planId"
],
"type": "object"
},
"name": "listTasks",
"outputSchema": {
"properties": {
"hasMore": {
"description": "True if more rows are available beyond the returned page.",
"type": "boolean"
},
"nextOffset": {
"description": "Pass as `offset` on the next call to continue paging.",
"type": "number"
},
"tasks": {
"description": "Page of tasks.",
"items": {
"type": "object"
},
"type": "array"
},
"totalCount": {
"description": "Total matching rows (when the data source provides it).",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "List teams in an organization, with optional search filter and an `includeMembers` flag that fans out to v_team_members in a single round-trip. Supply EITHER organizationId OR workspaceId (the workspace's parent org is resolved automatically). Use this when the user asks about teams generically (e.g. 'show me my teams') or before assigning a team via updateImprovement(owner_team_id=…). Read-only.",
"inputSchema": {
"properties": {
"includeMembers": {
"description": "When true, each team gets a `members` array (user_id, role, joined_at). Capped at 500 total members across the page. Default false.",
"type": "boolean"
},
"limit": {
"description": "Max teams per page (1-200, default 50).",
"type": "number"
},
"offset": {
"description": "Pagination offset.",
"type": "number"
},
"organizationId": {
"description": "Organization UUID. Either this OR workspaceId is required.",
"type": "string"
},
"q": {
"description": "Deprecated alias for `query`, still accepted. Prefer `query` — that is the name every other list tool uses.",
"type": "string"
},
"query": {
"description": "Optional ILIKE search on team name/slug.",
"type": "string"
},
"workspaceId": {
"description": "Workspace UUID. The parent organization is resolved from v_workspaces.",
"type": "string"
}
},
"type": "object"
},
"name": "listTeams",
"outputSchema": {
"properties": {
"hasMore": {
"description": "True if more rows are available beyond the returned page.",
"type": "boolean"
},
"nextOffset": {
"description": "Pass as `offset` on the next call to continue paging.",
"type": "number"
},
"teams": {
"description": "Page of teams.",
"items": {
"type": "object"
},
"type": "array"
},
"totalCount": {
"description": "Total matching rows (when the data source provides it).",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Search the built-in library of structural whiteboard stencils — ready-made hand-drawn graphics: flowchart/UML/ER/BPMN symbols, scrum columns, org-chart nodes, gantt, lo-fi/UX wireframe widgets (buttons, forms, tables, alerts, navs), charts, device frames, stick figures. A stencil is a MINI-WHITEBOARD (a collection of elements), NOT a single shape. Each result returns: `key`, `title` (a real human name e.g. 'Alerts', not an index), `kind` ('symbol' | 'template'), `labels` (the TEXT it actually contains — its real content, e.g. an Alerts template's variant messages), `size` ({w,h} px), `summary`, `pack`, `category`; plus the full pack/category lists. The two kinds are used DIFFERENTLY: • SYMBOL = one atomic labelled node (flowchart Process/Decision, BPMN task, org node). Place + label + connect: addWhiteboardElements({type:'stencil', stencilKey, id:'n1', text:'Review', width, height}) — the text auto-fits its single slot and an arrow's start/end {id:'n1'} binds to it like any shape. A few symbols are text-less FRAMES (e.g. a UML class box = rectangle + divider line): place create-only, then use the placement result's `children` (shapes + x/y/w/h) and `groupId` to add type:'text' specs INTO the regions — pass that groupId so the text is one unit with the frame. • TEMPLATE = a multi-component layout (Alerts, Forms, Tables, Charts, device frames). Place the WHOLE thing: addWhiteboardElements({type:'stencil', stencilKey, x, y, width?, height?}); the placement RESULT returns `stencils[].children` (each child's id + text + colour + position x/y/w/h, so you can group children into rows/sections) so you then keep / retext / recolour / DELETE specific parts via updateWhiteboardScene (e.g. delete the info + error rows to keep only the green success alert). Do NOT pass a single `text` to a template — read its `labels` to see its parts, then edit them by id. To make several similar items, build one then duplicateWhiteboardElements({groupId, dx}) to stamp consistent copies (like copy-paste in the UI). SEARCH TIPS: prefer BROAD single words ('decision','alert','form','phone','process'); content words match the embedded `labels` too (searching 'success' finds the Alerts template). If nothing exact matches, results auto-broaden (broadened:true); pass pack/category to browse. For cloud/architecture ICONS (AWS/Azure/GCP/Docker/Kubernetes/databases) use listArchitectureIcons; for a sticky/post-it use addWhiteboardElements({type:'sticky'}), not a stencil.",
"inputSchema": {
"properties": {
"category": {
"description": "Filter by category: 'Notes & Planning', 'Diagramming', 'UI & Wireframing', 'Data & Charts', 'People & Fun'.",
"type": "string"
},
"limit": {
"description": "Max results (default 60, max 200).",
"type": "number"
},
"pack": {
"description": "Restrict to one pack, e.g. 'Flowchart', 'BPMN', 'UML & ER', 'Scrum Board', 'Lo-Fi Wireframes', 'Org Chart'.",
"type": "string"
},
"query": {
"description": "Free-text search across name + pack + category (e.g. 'decision', 'database table', 'phone frame', 'actor', 'kanban column').",
"type": "string"
}
},
"type": "object"
},
"name": "listWhiteboardStencils",
"outputSchema": {
"properties": {
"hasMore": {
"description": "True if more rows are available beyond the returned page.",
"type": "boolean"
},
"items": {
"items": {
"type": "object"
},
"type": "array"
},
"nextOffset": {
"description": "Pass as `offset` on the next call to continue paging.",
"type": "number"
},
"totalCount": {
"description": "Total matching rows (when the data source provides it).",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "List AND grep the whiteboards in a project (hidden whiteboard-kind documents). `query` searches the title and friendlyId (substring by default; set isRegex:true for a regular expression, caseSensitive:true for exact case). This is the tool to find a board by name — listDocuments deliberately excludes whiteboards. Returns documentId, diagramId, title and timestamps for each.",
"inputSchema": {
"properties": {
"caseSensitive": {
"description": "Match case exactly. Default false.",
"type": "boolean"
},
"isRegex": {
"description": "Treat `query` as a regular expression.",
"type": "boolean"
},
"projectId": {
"type": "string"
},
"query": {
"description": "Grep across title and friendlyId. Substring by default; a regular expression when isRegex is true.",
"type": "string"
}
},
"required": [
"projectId"
],
"type": "object"
},
"name": "listWhiteboards",
"outputSchema": {
"properties": {
"hasMore": {
"description": "True if more rows are available beyond the returned page.",
"type": "boolean"
},
"items": {
"items": {
"type": "object"
},
"type": "array"
},
"nextOffset": {
"description": "Pass as `offset` on the next call to continue paging.",
"type": "number"
},
"totalCount": {
"description": "Total matching rows (when the data source provides it).",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "List workspaces you have access to. Scope to one organisation with organisationId (a structural filter — use it rather than `query`, which only searches names/slugs). Supports query filtering by name/slug.",
"inputSchema": {
"properties": {
"dateField": {
"description": "Date field to filter. Default: updated_at.",
"type": "string"
},
"fields": {
"description": "Field projection. Valid fields: id, name, slug, organization_id, created_at, updated_at.",
"items": {
"type": "string"
},
"type": "array"
},
"fromDate": {
"description": "ISO 8601 date filter (from).",
"type": "string"
},
"limit": {
"type": "number"
},
"offset": {
"type": "number"
},
"organisationId": {
"description": "Return only workspaces in this organisation. Use listOrganisations to find the id. (organizationId is accepted as a spelling alias.)",
"type": "string"
},
"organizationId": {
"description": "Spelling alias for organisationId.",
"type": "string"
},
"query": {
"type": "string"
},
"toDate": {
"description": "ISO 8601 date filter (to).",
"type": "string"
}
},
"type": "object"
},
"name": "listWorkspaces",
"outputSchema": {
"properties": {
"hasMore": {
"description": "True if more rows are available beyond the returned page.",
"type": "boolean"
},
"nextOffset": {
"description": "Pass as `offset` on the next call to continue paging.",
"type": "number"
},
"totalCount": {
"description": "Total matching rows (when the data source provides it).",
"type": "number"
},
"workspaces": {
"description": "Page of workspaces.",
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
{
"description": "Poll the status of a signup begun via `startSignup`. Anonymous-callable. Possible status values: `pending` (user has not yet authorized — keep polling), `authorized` (success — response includes `api_key`, `organization_id`, `user_id`, `user_email`; the api_key is returned ONCE), `consumed` (already returned the api_key on a previous poll — stop polling), `denied` (user clicked Deny), `expired` (10-minute TTL exceeded — call startSignup again), `not_found` (invalid device_code), `slow_down` (you're polling faster than the interval — back off).",
"inputSchema": {
"properties": {
"device_code": {
"description": "The device_code returned from startSignup.",
"type": "string"
}
},
"required": [
"device_code"
],
"type": "object"
},
"name": "pollSignupStatus",
"outputSchema": {
"properties": {
"api_key": {
"description": "Set when status=approved. Format: sta_*.",
"type": "string"
},
"organisation_id": {
"type": "string"
},
"status": {
"enum": [
"pending",
"approved",
"denied",
"expired"
],
"type": "string"
},
"user_id": {
"type": "string"
}
},
"type": "object"
}
},
{
"description": "Preview the cost / coverage / ETA of a full KG rebuild for the org (optionally narrowed to a workspace or project). Returns confirmation_token (10-min TTL). Rate limit 20/h.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"force": {
"type": "boolean"
},
"organisation_id": {
"type": "string"
},
"project_id": {
"type": "string"
},
"workspace_id": {
"type": "string"
}
},
"required": [
"organisation_id"
],
"type": "object"
},
"name": "previewKgRebuild",
"outputSchema": {
"properties": {
"confirmation_token": {
"description": "Server-minted token. Pass to the matching apply* tool to commit the change. Single-use, 10-minute TTL.",
"type": "string"
},
"expires_at": {
"format": "date-time",
"type": "string"
},
"summary": {
"description": "Human-readable summary of the proposed change for the user to review before confirming.",
"type": "object"
}
},
"type": "object"
}
},
{
"description": "Preview the credit cost, source counts, and ETA of including or excluding KG scope rows. Returns confirmation_token (10-min TTL) plus delta of newly-in-scope vs newly-out-of-scope sources. Rate limit 20/h.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"changes": {
"items": {
"additionalProperties": false,
"properties": {
"new_state": {
"enum": [
"on",
"off",
"inherit"
],
"type": "string"
},
"scope_id": {
"type": "string"
},
"scope_type": {
"enum": [
"organisation",
"workspace",
"project",
"folder",
"document"
],
"type": "string"
}
},
"required": [
"scope_type",
"scope_id",
"new_state"
],
"type": "object"
},
"maxItems": 200,
"minItems": 1,
"type": "array"
},
"organisation_id": {
"type": "string"
}
},
"required": [
"organisation_id",
"changes"
],
"type": "object"
},
"name": "previewKgScopeChange",
"outputSchema": {
"properties": {
"confirmation_token": {
"description": "Server-minted token. Pass to the matching apply* tool to commit the change. Single-use, 10-minute TTL.",
"type": "string"
},
"expires_at": {
"format": "date-time",
"type": "string"
},
"summary": {
"description": "Human-readable summary of the proposed change for the user to review before confirming.",
"type": "object"
}
},
"type": "object"
}
},
{
"description": "Preview the consequences of cancelling. Returns confirmation_token plus summary {remaining_credits, prepaid_days, prepaid_value_aud, feature_loss[], at_risk_seats}. Soft cancel only. Rate limit 30/h. Use when the user asks to cancel, end, or stop their subscription — ALWAYS call this first to show the cost of cancelling before passing the token to cancelSubscription.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"organisation_id": {
"type": "string"
}
},
"required": [
"organisation_id"
],
"type": "object"
},
"name": "previewSubscriptionCancellation",
"outputSchema": {
"properties": {
"confirmation_token": {
"description": "Server-minted token. Pass to the matching apply* tool to commit the change. Single-use, 10-minute TTL.",
"type": "string"
},
"expires_at": {
"format": "date-time",
"type": "string"
},
"summary": {
"description": "Human-readable summary of the proposed change for the user to review before confirming.",
"type": "object"
}
},
"type": "object"
}
},
{
"description": "Preview a subscription tier or seat change. Returns confirmation_token (10-min TTL) plus proration and next-invoice math. Cross-tier upgrades from Free return requires_checkout=true; the apply step creates a hosted Stripe Checkout session. Rate limit 30/h. Use when the user asks to upgrade their plan (free→pro), downgrade, add seats, increase seats, or change subscription tier — ALWAYS call this preview first, then applySubscriptionChange with the returned token after the user confirms.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"organisation_id": {
"type": "string"
},
"target_seats": {
"minimum": 1,
"type": "integer"
},
"target_tier": {
"enum": [
"free",
"pro",
"enterprise"
],
"type": "string"
}
},
"required": [
"organisation_id",
"target_tier"
],
"type": "object"
},
"name": "previewSubscriptionChange",
"outputSchema": {
"properties": {
"confirmation_token": {
"description": "Server-minted token. Pass to the matching apply* tool to commit the change. Single-use, 10-minute TTL.",
"type": "string"
},
"expires_at": {
"format": "date-time",
"type": "string"
},
"summary": {
"description": "Human-readable summary of the proposed change for the user to review before confirming.",
"type": "object"
}
},
"type": "object"
}
},
{
"description": "Dry-run of `applyTaskDependencyCascade` — returns the diff without writing. Empty items array means the plan is already consistent. Accepts the same `pinnedItemIds` and `forwardOnly` params.",
"inputSchema": {
"properties": {
"forwardOnly": {
"type": "boolean"
},
"pinnedItemIds": {
"items": {
"type": "string"
},
"type": "array"
},
"planId": {
"description": "Plan to evaluate.",
"type": "string"
}
},
"required": [
"planId"
],
"type": "object"
},
"name": "previewTaskDependencyCascade",
"outputSchema": {
"properties": {
"confirmation_token": {
"description": "Server-minted token. Pass to the matching apply* tool to commit the change. Single-use, 10-minute TTL.",
"type": "string"
},
"expires_at": {
"format": "date-time",
"type": "string"
},
"summary": {
"description": "Human-readable summary of the proposed change for the user to review before confirming.",
"type": "object"
}
},
"type": "object"
}
},
{
"description": "Apply a credit-package quote by creating a hosted Stripe Checkout session. Returns checkout_url + session_id. Refuses if catalogued price has drifted. Rate limit 5/h. Use only AFTER quoteCreditPackage and after the user confirms — never start a checkout without the quote step first.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"quote_token": {
"type": "string"
}
},
"required": [
"quote_token"
],
"type": "object"
},
"name": "purchaseCreditPackage",
"outputSchema": {
"properties": {
"applied": {
"description": "True when the apply call has been atomically committed.",
"type": "boolean"
},
"ok": {
"type": "boolean"
}
},
"type": "object"
}
},
{
"description": "Quote a credit-package purchase (first half of the human-in-the-loop ritual). Returns quote_token (10-min TTL) plus package + total_aud. Caller must invoke purchaseCreditPackage(quote_token) within the TTL. Use when the user asks to buy credits, purchase credits, top up credits, or add more credits — ALWAYS call this first then purchaseCreditPackage after the user confirms.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"organisation_id": {
"type": "string"
},
"package_id": {
"description": "v_credit_packages.id",
"type": "string"
}
},
"required": [
"organisation_id",
"package_id"
],
"type": "object"
},
"name": "quoteCreditPackage",
"outputSchema": {
"properties": {
"confirmation_token": {
"description": "Server-minted token. Pass to the matching apply* tool to commit the change. Single-use, 10-minute TTL.",
"type": "string"
},
"expires_at": {
"format": "date-time",
"type": "string"
},
"summary": {
"description": "Human-readable summary of the proposed change for the user to review before confirming.",
"type": "object"
}
},
"type": "object"
}
},
{
"description": "Reactivate a subscription that was scheduled to cancel at period end (clears cancel_at_period_end). Rate limit 5/h. Use when the user asks to reactivate, uncancel, restore, or keep their subscription after they previously cancelled but before the period ends.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"organisation_id": {
"type": "string"
}
},
"required": [
"organisation_id"
],
"type": "object"
},
"name": "reactivateSubscription",
"outputSchema": {
"properties": {
"subscription": {
"type": "object"
}
},
"type": "object"
}
},
{
"description": "Internal maintenance (requires write). Syncs gte-small (384-dim) vector embeddings for every platform catalog (MCP tools, whiteboard stencils, architecture icons, infographic templates, whiteboard design components, and open-design skills) into platform_catalog_embeddings, so the semantic search behind searchTools, listWhiteboardStencils, listArchitectureIcons, and the design-skill / component browsers stays current. Incremental: scans every catalog, diffs by content hash, and re-embeds ONLY changed rows (cheap no-op when nothing changed). This normally runs automatically every hour (the platform-catalog-sync cron), so manual calls are rarely needed; use it to force an immediate sync after changing any catalog. Embeds up to ~120 changed rows per call; if more changed, call again until allDone is true. Not part of normal authoring flows.",
"inputSchema": {
"properties": {
"types": {
"description": "Which catalogs to sync. Defaults to all six (tool, stencil, icon, infographic_template, whiteboard_component, skill).",
"items": {
"enum": [
"tool",
"stencil",
"icon",
"infographic_template",
"whiteboard_component",
"skill"
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"name": "rebuildPlatformCatalogEmbeddings",
"outputSchema": {
"type": "object"
}
},
{
"description": "Hard-remove a member from an organisation, cascading to workspace and team memberships and resource permissions. Refuses self-removal and last-owner removal. Stripe seat downgrade is NOT performed here — pair with a Phase 6 billing tool. Rate limit 5/min. Use when the user asks to remove, kick out, fire, offboard, or fully terminate a member's access to the organisation.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"organisation_id": {
"type": "string"
},
"user_id": {
"type": "string"
}
},
"required": [
"organisation_id",
"user_id"
],
"type": "object"
},
"name": "removeMember",
"outputSchema": {
"properties": {
"deleted_id": {
"type": "string"
},
"ok": {
"description": "Alias of success.",
"type": "boolean"
},
"success": {
"description": "True when the deletion completed.",
"type": "boolean"
}
},
"type": "object"
}
},
{
"description": "Remove a user from a team. Idempotent — returns removed=false if not on the team.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"team_id": {
"type": "string"
},
"user_id": {
"type": "string"
}
},
"required": [
"team_id",
"user_id"
],
"type": "object"
},
"name": "removeTeamMember",
"outputSchema": {
"properties": {
"deleted_id": {
"type": "string"
},
"ok": {
"description": "Alias of success.",
"type": "boolean"
},
"success": {
"description": "True when the deletion completed.",
"type": "boolean"
}
},
"type": "object"
}
},
{
"description": "Remove a member from a workspace. Caller must be a workspace owner or admin. Refuses to remove the last remaining workspace owner.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"user_id": {
"type": "string"
},
"workspace_id": {
"type": "string"
}
},
"required": [
"workspace_id",
"user_id"
],
"type": "object"
},
"name": "removeWorkspaceMember",
"outputSchema": {
"properties": {
"deleted_id": {
"type": "string"
},
"ok": {
"description": "Alias of success.",
"type": "boolean"
},
"success": {
"description": "True when the deletion completed.",
"type": "boolean"
}
},
"type": "object"
}
},
{
"description": "Generate a diagram from its DSL/code and get the IMAGE back — WITHOUT inserting it into any document or whiteboard. For acting as a pure diagram generator. Provide diagramType (e.g. 'default', 'mermaid', 'd2', 'plantuml', 'graphviz', 'bpmn', 'vegalite'; call listDiagramTypes for the full set) and source (the diagram code). Choose format 'png' (default), 'jpeg', or 'svg'; for raster choose scale 1/2/3 for 1x/2x/3x; optional background (png only). Returns a TEMPORARY imageUrl that stays available for 1 hour (the render is then deleted), and for png/jpeg the image inline so you can see it. The link carries no signing token, so it survives being rendered as a citation. To render a diagram that already lives in a document/whiteboard use getDiagramImage; to persist a new one use insertDiagramInDocument or insertWhiteboardDiagram.",
"inputSchema": {
"properties": {
"applyBrandTheme": {
"description": "Brand theming is ON BY DEFAULT: the effective BRAND KIT (colours only — typefaces are never injected) is baked into the diagram before rendering (cascade: brandKitId override → project default → workspace default → org default → the built-in Stable Baseline theme). Set false to render with the library's stock styling instead. Themable types: mermaid, plantuml, graphviz, d2, systemsarchitecture, vega, vegalite, infographic — other types always render unchanged. Author theming in the DSL wins (an existing mermaid %%{init}%%, plantuml !theme, d2 vars.d2-config, or a hand-written infographic palette is never overridden).",
"type": "boolean"
},
"background": {
"description": "Background for png/jpeg, e.g. '#ffffff' or 'transparent' (png only).",
"type": "string"
},
"brandKitId": {
"description": "Optional brand kit UUID (see listBrandKits) to theme with instead of the cascade default. Must belong to your organisation.",
"type": "string"
},
"diagramType": {
"description": "Diagram language, e.g. 'default', 'mermaid', 'd2', 'plantuml', 'graphviz', 'bpmn', 'vegalite'. For a diagram family, use its defaultRenderer from listDiagramTypes.",
"type": "string"
},
"format": {
"description": "png (default) or jpeg = raster; svg is scalable. A platform default diagram's SVG contains a browser foreignObject scene, so use PNG/JPEG where foreignObject SVG is unsupported.",
"enum": [
"png",
"jpeg",
"svg"
],
"type": "string"
},
"projectId": {
"description": "Optional project UUID used to resolve the project → workspace → org brand-kit cascade. Without it the built-in Stable Baseline brand themes the render.",
"type": "string"
},
"scale": {
"description": "Raster resolution multiplier 1x/2x/3x (default 2). Ignored for svg.",
"enum": [
1,
2,
3
],
"type": "number"
},
"source": {
"description": "The diagram DSL / code to render. For 'default', provide MDP JSON with stable IDs and omit entity x/y for automatic layout; fully positioned manual sources remain valid; icons must be exact iconKey values from listArchitectureIcons. For 'infographic', provide a plain-English description instead (the system designs the AntV infographic spec).",
"type": "string"
}
},
"required": [
"diagramType",
"source"
],
"type": "object"
},
"name": "renderDiagram",
"outputSchema": {
"type": "object"
}
},
{
"description": "MOVE documents between folders and/or reorder them — the batch filing tool. Pass [{documentId, folderId?, position?}, ...] and give at least one of folderId/position per item. `folderId` MOVES that document into the given folder; use null for the project root; omit it to leave the document in its current folder. `position` sets the sort order among siblings — OMIT IT to append the document to the end of wherever it lands (or to keep its current place if it is not moving), which is usually what you want when filing. Use this to reorganise a project — file loose documents into subfolders, restructure a folder tree, or reorder siblings — in one call. The whole batch is applied in a SINGLE atomic database write, so it either all lands or none of it does; a bad folderId or an unreachable documentId fails the call with nothing changed. Filing is metadata only: it does NOT bump the document version and does NOT create a version-history snapshot, so tidying folders never shows up as a content revision. The response echoes the position the server actually assigned to each document. For a single document you can also use editDocument({documentId, folderId, position}), which behaves identically (and likewise creates no version when only the filing changes).",
"inputSchema": {
"properties": {
"items": {
"description": "Documents to file. All must belong to the same project (a batch spanning projects is rejected).",
"items": {
"properties": {
"documentId": {
"type": "string"
},
"folderId": {
"description": "MOVE the document into this folder; null moves it to the project root. Omit to leave its current folder untouched. The folder must exist and belong to the same project.",
"type": [
"string",
"null"
]
},
"position": {
"description": "Optional. Sort position among siblings (non-negative integer). OMIT to let the server place it: appended to the end of the target folder when the folder changes, otherwise left where it is. Omitting is the norm when filing; supply positions only when you are deliberately ordering siblings, usually renumbering them 0, 1, 2….",
"type": "number"
}
},
"required": [
"documentId"
],
"type": "object"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"items"
],
"type": "object"
},
"name": "reorderDocuments",
"outputSchema": {
"properties": {
"reordered": {
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Batch-reorder folders within a parent (or project root) by setting sibling positions. Pass [{folderId, position}, ...] where position is a non-negative integer; usually you renumber siblings sequentially as 0, 1, 2…. To MOVE a folder to a different parent and set its position there, use updateFolder({parentId, position}) instead.",
"inputSchema": {
"properties": {
"items": {
"description": "List of folder position updates. All folders must belong to the same project.",
"items": {
"properties": {
"folderId": {
"type": "string"
},
"position": {
"type": "number"
}
},
"required": [
"folderId",
"position"
],
"type": "object"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"items"
],
"type": "object"
},
"name": "reorderFolders",
"outputSchema": {
"properties": {
"reordered": {
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Reorder improvement categories by setting sort_order values.",
"inputSchema": {
"properties": {
"items": {
"description": "Array of {categoryId, sortOrder}.",
"items": {
"properties": {
"categoryId": {
"type": "string"
},
"sortOrder": {
"type": "number"
}
},
"required": [
"categoryId",
"sortOrder"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"items"
],
"type": "object"
},
"name": "reorderImprovementCategories",
"outputSchema": {
"properties": {
"categories": {
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
{
"description": "Reorder plan phases by setting position values. WBS codes are recalculated.",
"inputSchema": {
"properties": {
"items": {
"description": "Array of {phaseId, position}.",
"items": {
"properties": {
"phaseId": {
"type": "string"
},
"position": {
"type": "number"
}
},
"required": [
"phaseId",
"position"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"items"
],
"type": "object"
},
"name": "reorderPlanPhases",
"outputSchema": {
"properties": {
"phases": {
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
{
"description": "Resend a pending invitation: extends expires_at by 7 days and re-triggers the invitation email. Server resolves the organisation_id from the invitation row. Rate limit 6/h per invitation_id. Use when the user asks to resend, re-send, or re-trigger an invitation email — typically because the recipient lost it or the original expired.",
"inputSchema": {
"properties": {
"invitation_id": {
"description": "Invitation UUID. Must currently be in 'pending' status.",
"type": "string"
}
},
"required": [
"invitation_id"
],
"type": "object"
},
"name": "resendInvitation",
"outputSchema": {
"properties": {
"invitation": {
"type": "object"
}
},
"type": "object"
}
},
{
"description": "Wipe + re-ingest a single document in the KG. Drops chunks/mentions/entities, clears pending lazy-extraction, and enqueues a fresh extract pass. Requires can_manage_kg + document write. Rate limit 30/min.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"document_id": {
"type": "string"
}
},
"required": [
"document_id"
],
"type": "object"
},
"name": "resetDocumentInBrain",
"outputSchema": {
"properties": {
"ok": {
"type": "boolean"
}
},
"type": "object"
}
},
{
"description": "Revoke a team's workspace access. Idempotent — returns revoked=false if no grant exists.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"team_id": {
"type": "string"
},
"workspace_id": {
"type": "string"
}
},
"required": [
"team_id",
"workspace_id"
],
"type": "object"
},
"name": "revokeTeamWorkspaceAccess",
"outputSchema": {
"properties": {
"deleted_id": {
"type": "string"
},
"ok": {
"description": "Alias of success.",
"type": "boolean"
},
"success": {
"description": "True when the deletion completed.",
"type": "boolean"
}
},
"type": "object"
}
},
{
"description": "Ranked semantic search over IMPROVEMENTS AND TASKS — hybrid full-text + vector, so it matches meaning rather than just wording. Returns ranked { improvements }, each with a versionTimestamp you can pass straight to updateImprovement without a getImprovement round-trip.\n\nImprovements and tasks are one table (a task is an improvement with is_task=true), so both are searched by default. Pass types:[\"task\"] or types:[\"improvement\"] to narrow to one.\n\nThis tool searches improvements and tasks ONLY. To find a document, whiteboard, plan or compliance item by name or friendly id, use kg_search({ query, artefactMetadataOnly: true }) — it matches title + friendly id + uuid across every artefact type and needs no knowledge graph. To search document CONTENT, use listDocuments.",
"inputSchema": {
"properties": {
"limit": {
"description": "Max results (default 20, max 50).",
"type": "number"
},
"projectId": {
"description": "Limit to a project.",
"type": "string"
},
"query": {
"description": "Search query — meaning, a name fragment, or a friendly id (e.g. \"IMP-2\", \"TAS-7\").",
"type": "string"
},
"types": {
"description": "Narrow to one kind. Omit (or pass both) to search improvements and tasks together. Other artefact types are NOT accepted here — use kg_search with artefactMetadataOnly:true for those.",
"items": {
"enum": [
"improvement",
"task"
],
"type": "string"
},
"type": "array"
},
"workspaceId": {
"description": "Limit to a workspace.",
"type": "string"
}
},
"required": [
"query"
],
"type": "object"
},
"name": "searchImprovements",
"outputSchema": {
"properties": {
"artefacts": {
"items": {
"type": "object"
},
"type": "array"
},
"hasMore": {
"description": "True if more rows are available beyond the returned page.",
"type": "boolean"
},
"improvements": {
"items": {
"type": "object"
},
"type": "array"
},
"matches": {
"items": {
"type": "object"
},
"type": "array"
},
"nextOffset": {
"description": "Pass as `offset` on the next call to continue paging.",
"type": "number"
},
"total": {
"type": "number"
},
"totalCount": {
"description": "Total matching rows (when the data source provides it).",
"type": "number"
},
"totalMatches": {
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Semantic search over the 276 AntV Infographic templates — call this FIRST when building an `infographic` diagram so you pick the right structure for the content. Describe the intent (e.g. 'compare two options', 'show a process timeline', 'pyramid of priorities', 'org hierarchy', 'flow between systems', 'parts of a whole'); results are vector-ranked. Each result has `key` (use as line 1 `infographic <key>`), `name`, `family` (list|sequence|compare|relation|chart|hierarchy|quadrant), and `description`. The result's `usage` explains the family→data-field mapping for writing the DSL.",
"inputSchema": {
"properties": {
"limit": {
"description": "Max templates to return (default 12).",
"type": "number"
},
"query": {
"description": "What the infographic should show (intent/topic), e.g. 'compare pros and cons', 'launch roadmap timeline', 'market share pie'.",
"type": "string"
}
},
"required": [
"query"
],
"type": "object"
},
"name": "searchInfographicTemplates",
"outputSchema": {
"properties": {
"hasMore": {
"description": "True if more rows are available beyond the returned page.",
"type": "boolean"
},
"matches": {
"items": {
"type": "object"
},
"type": "array"
},
"nextOffset": {
"description": "Pass as `offset` on the next call to continue paging.",
"type": "number"
},
"totalCount": {
"description": "Total matching rows (when the data source provides it).",
"type": "number"
},
"totalMatches": {
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Search available tools by keyword or category. Returns matching tool names and descriptions.",
"inputSchema": {
"properties": {
"category": {
"description": "Category filter. One of the 18 categories returned in each result's `category` field.",
"enum": [
"navigation",
"folders",
"documents",
"diagrams",
"images",
"whiteboards",
"data",
"improvements",
"plans",
"knowledge_graph",
"organization",
"members",
"teams",
"permissions",
"billing",
"kg_admin",
"settings",
"signup"
],
"type": "string"
},
"query": {
"description": "Natural language description of what you want to do.",
"type": "string"
}
},
"type": "object"
},
"name": "searchTools",
"outputSchema": {
"properties": {
"categories": {
"items": {
"type": "string"
},
"type": "array"
},
"error": {
"description": "Set when category filter is invalid.",
"type": "string"
},
"matches": {
"description": "Tool catalogue entries ranked by relevance to the query.",
"items": {
"properties": {
"category": {
"type": "string"
},
"description": {
"type": "string"
},
"name": {
"type": "string"
},
"score": {
"type": "number"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "Set when query/category is missing — agent should retry.",
"type": "string"
},
"toolCountByCategory": {
"type": "object"
},
"totalMatches": {
"type": "number"
},
"totalTools": {
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Set or clear the default BRAND KIT at a scope: organization, workspace, project, folder, or document. Defaults cascade most-specific-first, lowest level up: document beats the nearest folder up the (nested) folder chain beats project beats workspace beats organization. Diagram brand theming, exports and decks all resolve through this cascade. Pass brandKitId:null to clear. Auth: org owner/admin.",
"inputSchema": {
"properties": {
"brandKitId": {
"description": "Brand kit to make default, or null to clear.",
"type": [
"string",
"null"
]
},
"scope": {
"enum": [
"organization",
"workspace",
"project",
"folder",
"document"
],
"type": "string"
},
"scopeId": {
"description": "The org/workspace/project/folder/document id for the chosen scope.",
"type": "string"
}
},
"required": [
"scope",
"scopeId"
],
"type": "object"
},
"name": "setDefaultBrandKit",
"outputSchema": {
"type": "object"
}
},
{
"description": "Toggle KG-scope override for a single document (on/off/inherit). Documents default to inheriting their folder/project gate. Requires can_manage_kg + document write. Rate limit 30/min.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"document_id": {
"type": "string"
},
"state": {
"enum": [
"on",
"off",
"inherit"
],
"type": "string"
}
},
"required": [
"document_id",
"state"
],
"type": "object"
},
"name": "setKgDocumentScope",
"outputSchema": {
"type": "object"
}
},
{
"description": "Toggle KG-scope override for a folder (on/off/inherit). Folders default to inheriting their project's scope. Requires can_manage_kg + folder write. Rate limit 30/min.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"folder_id": {
"type": "string"
},
"state": {
"enum": [
"on",
"off",
"inherit"
],
"type": "string"
}
},
"required": [
"folder_id",
"state"
],
"type": "object"
},
"name": "setKgFolderScope",
"outputSchema": {
"type": "object"
}
},
{
"description": "Set the KG visibility mode for a project: 'strict' (multi-source rows hidden unless user can read every source), 'permissive' (one source suffices), or 'open' (any org member). Controls WHO can see the project's KG rows. Requires can_manage_kg + project write. Rate limit 30/min.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"mode": {
"enum": [
"strict",
"permissive",
"open"
],
"type": "string"
},
"project_id": {
"type": "string"
}
},
"required": [
"project_id",
"mode"
],
"type": "object"
},
"name": "setKgProjectVisibility",
"outputSchema": {
"type": "object"
}
},
{
"description": "Toggle whether a workspace is in the Knowledge Graph (on/off/inherit). 'on' enables the workspace as a gate for indexing its projects; 'off' excludes everything under it; 'inherit' removes the explicit override. No re-ingest happens here. Requires can_manage_kg + workspace write. Rate limit 30/min.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"state": {
"enum": [
"on",
"off",
"inherit"
],
"type": "string"
},
"workspace_id": {
"type": "string"
}
},
"required": [
"workspace_id",
"state"
],
"type": "object"
},
"name": "setKgWorkspaceScope",
"outputSchema": {
"type": "object"
}
},
{
"description": "Soft-deactivate or reactivate an organisation member. Refuses self-deactivation, last-admin/owner deactivation, and deactivation of an owner. Rate limit 30/min. Use when the user asks to deactivate, suspend, freeze, reactivate, or unfreeze a member without fully removing them.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"is_active": {
"type": "boolean"
},
"organisation_id": {
"type": "string"
},
"user_id": {
"type": "string"
}
},
"required": [
"organisation_id",
"user_id",
"is_active"
],
"type": "object"
},
"name": "setMemberActive",
"outputSchema": {
"properties": {
"member": {
"type": "object"
}
},
"type": "object"
}
},
{
"description": "Set or clear the plan outline (WBS) nesting of a task or improvement: the indent inside one plan phase, with no scheduling effect. Parent and child must be in the same plan and the same phase, and the WBS numbers are recalculated. Max depth: 5. This is NOT the work hierarchy: for an epic's stories or a story's tasks or test cases, in any plan or phase, set parentItemId with createImprovement, updateImprovement, createTask or updateTask instead.",
"inputSchema": {
"properties": {
"itemId": {
"description": "Item ID to indent or un-indent in the plan outline.",
"type": "string"
},
"parentId": {
"description": "The outline parent's ID, in the same plan and phase. Null to un-indent. Not the work hierarchy parent (parentItemId).",
"type": "string"
}
},
"required": [
"itemId"
],
"type": "object"
},
"name": "setPlanItemParent",
"outputSchema": {
"properties": {
"item": {
"type": "object"
}
},
"type": "object"
}
},
{
"description": "Set a single 3-state override on a permission row: null=inherit, true=allow, false=deny. Per-axis (read/write/delete) and per-kind (documents/improvements/plans), matching the OverrideAccessSection UI. Rate limit 30/min.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"axis": {
"enum": [
"read",
"write",
"delete"
],
"type": "string"
},
"override_kind": {
"enum": [
"documents",
"improvements",
"plans"
],
"type": "string"
},
"permission_id": {
"type": "string"
},
"value": {
"description": "true=allow, false=deny, null=inherit",
"type": [
"boolean",
"null"
]
}
},
"required": [
"permission_id",
"override_kind",
"axis",
"value"
],
"type": "object"
},
"name": "setResourcePermissionOverride",
"outputSchema": {
"properties": {
"permission": {
"type": "object"
}
},
"type": "object"
}
},
{
"description": "Invite the Stable Baseline Meeting Scribe bot to a LIVE meeting (Zoom, Google Meet, Microsoft Teams, or Webex) so it paints a live, editable whiteboard of the conversation as it happens: sticky notes and topic clusters, an agenda that ticks itself off, and decisions and actions pinned to rails, on a real board the team keeps working in afterwards. The bot transcribes only and stores no recording. WHITEBOARD IS REQUIRED: the scribe always paints an existing whiteboard, so documentId (the whiteboard's id) is required. If you do not have a whiteboard id, ASK THE USER which whiteboard to use; do not create one automatically. COST + APPROVAL: it bills 2 credits per minute in 5-minute blocks while it runs (a 60-minute meeting is about 120 credits; hard cap 180 minutes), and it needs the user's explicit approval. Call FIRST without confirm to get the exact quote plus the workspace balance, show that to the user, and only call again with confirm:true once they agree. Available on the Pro and Enterprise plans. It returns immediately with a sessionId; poll getMeetingScribeStatus to watch it join and paint, and stopMeetingScribe to end it. The user can also just remove the bot from the meeting to stop it.",
"inputSchema": {
"properties": {
"agenda": {
"description": "Optional agenda pre-drawn on the board as a left rail; each item gets a status sticker (pending, active, done) as the conversation reaches it. Omit to let the rail build itself from the topics that emerge.",
"items": {
"description": "One agenda item.",
"properties": {
"id": {
"description": "Optional stable id; one is minted if omitted.",
"type": "string"
},
"label": {
"description": "The agenda item text.",
"type": "string"
},
"status": {
"description": "Optional starting status sticker. Default: pending.",
"enum": [
"pending",
"active",
"done"
],
"type": "string"
}
},
"required": [
"label"
],
"type": "object"
},
"type": "array"
},
"confirm": {
"description": "Set true ONLY after the user has approved the per-minute cost. Leave unset/false on the first call to receive the quote plus balance.",
"type": "boolean"
},
"documentId": {
"description": "The whiteboard the scribe paints into. REQUIRED: a meeting scribe always paints an existing board. If you do not have a whiteboard id, ask the user which whiteboard to use; never create one automatically.",
"type": "string"
},
"meetingUrl": {
"description": "The meeting link to join: a Zoom, Google Meet, Microsoft Teams, or Webex URL (https only). Any other host is rejected.",
"type": "string"
},
"settings": {
"additionalProperties": true,
"description": "Optional per-meeting settings: { language (BCP-47, e.g. 'en'), sttProvider ('assemblyai' default, or 'captions'), presentMode ('off' default, or 'camera'/'screenshare' to stream the live board back into the meeting), botName (override the default '{Org} Scribe (Stable Baseline)') }.",
"type": "object"
}
},
"required": [
"documentId",
"meetingUrl"
],
"type": "object"
},
"name": "startMeetingScribe",
"outputSchema": {
"type": "object"
}
},
{
"description": "Begin an agent-driven sign-up to Stable Baseline. Anonymous-callable. Returns a `verification_url` and a 6-character `user_code` that the agent must show to the user. The user opens the URL in their browser, signs in or signs up if necessary, enters the code, and clicks Authorize. The agent meanwhile polls `pollSignupStatus({device_code})` every `poll_interval_seconds` until the status changes to `authorized`, at which point it receives an `api_key` it can use for subsequent MCP calls. The whole flow has a 10-minute TTL.",
"inputSchema": {
"properties": {
"agent_label": {
"description": "Self-identification of the calling agent (e.g. 'Claude Desktop', 'Cursor', 'Custom CLI'). Shown to the user on the confirmation page so they know what they're authorizing.",
"maxLength": 60,
"type": "string"
},
"desired_org_name": {
"description": "Optional hint for the org name to suggest if the user has no organisation yet. Ignored for users who already have an org.",
"maxLength": 80,
"type": "string"
},
"intent": {
"description": "Reason for the signup. Currently only 'mcp_setup' is supported.",
"enum": [
"mcp_setup"
],
"type": "string"
}
},
"type": "object"
},
"name": "startSignup",
"outputSchema": {
"properties": {
"device_code": {
"type": "string"
},
"expires_at": {
"type": "string"
},
"interval": {
"description": "Seconds between pollSignupStatus calls.",
"type": "number"
},
"user_code": {
"type": "string"
},
"verification_url": {
"type": "string"
},
"verification_url_complete": {
"type": "string"
}
},
"type": "object"
}
},
{
"description": "Stop a running meeting scribe: the bot leaves the meeting and the board is finalised (tidy pass plus a summary frame). Give it the sessionId returned by startMeetingScribe. Billing stops at the current block; the user can also stop the scribe simply by removing the bot from the meeting.",
"inputSchema": {
"properties": {
"sessionId": {
"description": "The meeting scribe session to stop, as returned by startMeetingScribe.",
"type": "string"
}
},
"required": [
"sessionId"
],
"type": "object"
},
"name": "stopMeetingScribe",
"outputSchema": {
"type": "object"
}
},
{
"description": "Turn a raster image into hand-drawn freedraw strokes on a whiteboard, deterministically. Pass an image (imageUrl OR imageBase64) plus a style; the server fetches and vectorises it server-side and draws the strokes, so you do NOT emit any coordinates yourself (LLMs are poor at that and it wastes tokens). Use this for requests like 'sketch this image onto the board', portraits, or turning a logo into line art. style: 'sketch' (~3 colors, clean line art; default), 'color' (~8 colors), 'poster' (~12 colors). Returns a compact summary (stroke count), never the raw coordinates. Auto-places to the right of existing content unless x/y are given.",
"inputSchema": {
"properties": {
"documentId": {
"description": "The whiteboard's documentId.",
"type": "string"
},
"imageBase64": {
"contentEncoding": "base64",
"description": "Base64-encoded image bytes (a data: URL prefix is allowed). Use instead of imageUrl.",
"type": "string"
},
"imageUrl": {
"description": "URL to fetch the image from (http/https; private and metadata hosts are blocked).",
"type": "string"
},
"maxColors": {
"description": "Palette size 2-16 (defaults by style: sketch 3, color 8, poster 12).",
"type": "number"
},
"maxStrokes": {
"description": "Cap on the number of strokes, 20-1200 (default 600). Lower = simpler and faster.",
"type": "number"
},
"mimeType": {
"description": "Optional image MIME type hint (e.g. 'image/png'); auto-detected otherwise.",
"type": "string"
},
"style": {
"description": "Vectorisation style. 'sketch' = clean line art (default), 'color' = more colors, 'poster' = posterised.",
"enum": [
"sketch",
"color",
"poster"
],
"type": "string"
},
"width": {
"description": "Target display width in px (default 520); the drawing scales to fit, aspect preserved.",
"type": "number"
},
"x": {
"description": "Top-left x on the canvas. Omit to auto-place to the right of existing content.",
"type": "number"
},
"y": {
"description": "Top-left y on the canvas. Omit to auto-place.",
"type": "number"
}
},
"required": [
"documentId"
],
"type": "object"
},
"name": "traceImage",
"outputSchema": {
"type": "object"
}
},
{
"description": "Apply a previously previewed KG rebuild. Dispatches the build batch via kg-rebuild and returns batch_id. Rate limit 5/h.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"confirmation_token": {
"type": "string"
}
},
"required": [
"confirmation_token"
],
"type": "object"
},
"name": "triggerKgRebuild",
"outputSchema": {
"properties": {
"batch_id": {
"type": "string"
},
"ok": {
"type": "boolean"
}
},
"type": "object"
}
},
{
"description": "Update the org's billing email. Validates format, writes private.organizations.billing_email, syncs to Stripe customer. Rate limit 30/h.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"email": {
"type": "string"
},
"organisation_id": {
"type": "string"
}
},
"required": [
"organisation_id",
"email"
],
"type": "object"
},
"name": "updateBillingEmail",
"outputSchema": {
"properties": {
"billing_email": {
"type": "string"
}
},
"type": "object"
}
},
{
"description": "Update a diagram's code, description, or properties. Call getDiagramTypeGuide for DSL syntax. New diagramCode is COMPILE-CHECKED BY RENDERING at write time — broken DSL is rejected with the renderer's error — and a valid change is re-rendered + re-thumbnailed immediately (response diagram.renderStatus tells you the outcome). Provide a version lock: diagramVersionTimestamp (from getDiagramInDocument, getDocument with includeDiagramDsl:true, or any diagram write's response — PREFERRED: locks just this diagram, so concurrent edits elsewhere in the document don't conflict; bare versionTimestamp is accepted as an alias) OR documentVersionTimestamp (locks the whole document). The response returns BOTH fresh tokens for chaining. Documents carrying a legacy marker (no embedded diagramId) are upgraded automatically on update. IMPORTANT: to change what the diagram visually shows you MUST provide diagramCode with the full updated DSL source — prompt/nlDescription are metadata only. After updating, view it with getDiagramImage and keep prompt/nlDescription in step with what the diagram now shows.",
"inputSchema": {
"properties": {
"align": {
"description": "Alignment.",
"enum": [
"left",
"center",
"right"
],
"type": "string"
},
"applyBrandTheme": {
"description": "Brand theming is ON BY DEFAULT when diagramCode is provided: the document's effective BRAND KIT is baked into the new DSL before it is validated, rendered and stored. Set false to keep the library's stock styling. Same cascade + themable types + author-wins guards as insertDiagramInDocument. The stored diagramCode is the THEMED source.",
"type": "boolean"
},
"brandKitId": {
"description": "Optional brand kit UUID (see listBrandKits) to theme with instead of the cascade default. Must belong to your organisation.",
"type": "string"
},
"caption": {
"description": "New caption.",
"type": "string"
},
"colorPlan": {
"description": "BPMN only. Updated color plan. Set to null to remove.",
"properties": {
"byElementId": {
"additionalProperties": {
"type": "string"
},
"description": "Map of element IDs to color swatch names.",
"type": "object"
}
},
"required": [
"byElementId"
],
"type": "object"
},
"diagramCode": {
"description": "New diagram DSL source code. REQUIRED to change what the diagram visually renders. Call getDiagramTypeGuide for syntax. Must provide the COMPLETE updated DSL, not just the changed parts. For 'default', provide complete MDP JSON and preserve stable IDs; omit entity x/y for automatic layout, or preserve all x/y in a manually positioned legacy diagram. Root layout.mode='auto' can explicitly rearrange an existing diagram. Its icons must be exact iconKey values from listArchitectureIcons. EXCEPTION — for type 'infographic', pass either a plain-English DESCRIPTION of the new infographic (the system designs, renders, and stores the AntV spec, same as insert) or complete AntV Infographic DSL (first line `infographic <template-name>`).",
"type": "string"
},
"diagramId": {
"description": "Diagram ID from DIAGRAM_OMITTED markers.",
"type": "string"
},
"diagramVersionTimestamp": {
"description": "Diagram-level optimistic lock: versionTimestamp of THIS diagram (from getDiagramInDocument, getDocument with includeDiagramDsl:true, or a previous write's response). Preferred: locks only this diagram, so concurrent edits to OTHER diagrams in the same document don't conflict. (Alias accepted: versionTimestamp.) The response returns the new diagram.versionTimestamp for chaining further edits.",
"type": "number"
},
"documentVersionTimestamp": {
"description": "Document-level optimistic lock: versionTimestamp from getDocument(). Locks the whole document. Provide this OR diagramVersionTimestamp (at least one is required).",
"type": "number"
},
"nlDescription": {
"description": "New extended description (metadata only — does NOT change the rendered diagram).",
"type": "string"
},
"prompt": {
"description": "New short description (metadata only — does NOT change the rendered diagram).",
"type": "string"
}
},
"required": [
"diagramId"
],
"type": "object"
},
"name": "updateDiagramInDocument",
"outputSchema": {
"properties": {
"diagram": {
"type": "object"
},
"href": {
"description": "Web URL of the resource in the Stable Baseline app.",
"type": "string"
},
"versionTimestamp": {
"description": "Milliseconds since epoch. Pass back as `versionTimestamp` on subsequent edit/update calls for optimistic locking.",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Update a folder (rename/move/reorder). Supports nesting changes via parentId.",
"inputSchema": {
"properties": {
"folderId": {
"type": "string"
},
"name": {
"type": "string"
},
"parentId": {
"type": "string"
},
"position": {
"type": "number"
}
},
"required": [
"folderId"
],
"type": "object"
},
"name": "updateFolder",
"outputSchema": {
"properties": {
"folder": {
"description": "The folder after the mutation.",
"type": "object"
},
"href": {
"description": "Web URL of the resource in the Stable Baseline app.",
"type": "string"
},
"versionTimestamp": {
"description": "Milliseconds since epoch. Pass back as `versionTimestamp` on subsequent edit/update calls for optimistic locking.",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Update image metadata (alt, caption, nlDescription, dimensions, alignment) — metadata only; to change the picture itself, delete it and insert the new one. Requires the document's versionTimestamp (from getDocument or any mutating tool's response) for optimistic locking.",
"inputSchema": {
"properties": {
"align": {
"description": "Alignment.",
"enum": [
"left",
"center",
"right"
],
"type": "string"
},
"alt": {
"description": "New alt text.",
"type": "string"
},
"caption": {
"description": "New caption.",
"type": "string"
},
"documentVersionTimestamp": {
"description": "Optimistic-lock token: the document's versionTimestamp from getDocument() or any mutating tool's response. (Alias accepted: versionTimestamp.)",
"type": "number"
},
"height": {
"description": "Height in pixels.",
"type": "number"
},
"imageId": {
"description": "Image ID from IMAGE_OMITTED markers.",
"type": "string"
},
"nlDescription": {
"description": "New image description.",
"type": "string"
},
"width": {
"description": "Width in pixels.",
"type": "number"
}
},
"required": [
"imageId"
],
"type": "object"
},
"name": "updateImageInDocument",
"outputSchema": {
"properties": {
"href": {
"description": "Web URL of the resource in the Stable Baseline app.",
"type": "string"
},
"image": {
"type": "object"
},
"versionTimestamp": {
"description": "Milliseconds since epoch. Pass back as `versionTimestamp` on subsequent edit/update calls for optimistic locking.",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Update an improvement, or many in one call (or a task: tasks share this row, but prefer the symmetric updateTask alias when working from getTask). Supports the full field set including `checklist` (tick-boxes with due dates + completion attribution), `acceptance_criteria` (objects with per-row updated_by/at attribution) and parentItemId (the epic or story it belongs to in the work hierarchy; null removes it). versionTimestamp (optimistic locking) is the item's updated_at in epoch milliseconds, and you rarely need a getImprovement call for it: listImprovements returns it for every improvement in a project (fields [\"id\", \"friendlyId\", \"versionTimestamp\"] keeps that answer short), getPlan (items[].versionTimestamp) for every item in a plan, and every write returns the new one. Pass `fields` (for example [\"id\", \"versionTimestamp\"]) for a short answer instead of the whole record. To change many improvements, send `items`: up to 200 entries of { improvementId, versionTimestamp, ...changes } per call (more than 200: split them into several calls of up to 200), each checked and written on its own and answered with one row per entry plus a summary. Statuses are captured / in_progress / blocked / done / rejected / deferred, and FOUR of those are CLOSED: blocked, done, rejected, deferred. Entering one needs its comment (blocked needs blocked_comment, rejected needs rejection_comment, done needs completion_comment); leaving one for an open status needs reopened_comment, including blocked -> in_progress, which surprises people because `blocked` does not sound terminal. `metadata` MERGES into what is stored (null on a key deletes it); pass metadata_replace:true to overwrite the object wholesale. Assignment: pass `owner_id=<uuid>` to assign to a user, `owner_team_id=<uuid>` to assign to a team (mutually exclusive: a DB CHECK constraint enforces this). To unassign, pass `owner_id=null` AND `owner_team_id=null`. To switch from a user owner to a team owner, send `owner_id=null, owner_team_id=<uuid>` in the SAME call (sending only one side leaves the stale value and triggers the XOR check). Use listAssignablePrincipals or listTeams to discover valid IDs.",
"inputSchema": {
"properties": {
"acceptance_criteria": {
"description": "Acceptance criteria — ordered list of pass/fail statements that define \"done\" for this item. Each row is `{ id, text }` with server-stamped `updated_at / updated_by / updated_by_credential_name`. REPLACES the whole array on update. Echo back existing `id`s on rows you keep so attribution stamps survive. Bare strings are accepted for convenience (e.g. `[\"row 1\", \"row 2\"]`) and auto-converted to `{ id, text }`.",
"items": {
"anyOf": [
{
"description": "Shorthand for `{ text: \"...\" }`.",
"type": "string"
},
{
"properties": {
"id": {
"description": "Optional — server mints one if omitted. Preserve on edits.",
"type": "string"
},
"text": {
"type": "string"
},
"updated_at": {
"description": "Server-stamped. Echo back unchanged; ignored on new rows.",
"type": "string"
},
"updated_by": {
"description": "Server-stamped user id. Echo back unchanged.",
"type": "string"
},
"updated_by_credential_name": {
"description": "Server-stamped credential label. Echo back unchanged.",
"type": "string"
}
},
"required": [
"text"
],
"type": "object"
}
]
},
"type": "array"
},
"agent_brief": {
"type": "string"
},
"agent_complexity": {
"type": "string"
},
"agent_confidence": {
"type": "number"
},
"agent_missing_info": {
"items": {
"type": "string"
},
"type": "array"
},
"agent_ready": {
"type": "boolean"
},
"agent_recommended_action": {
"type": "string"
},
"blocked_comment": {
"description": "Required when status=blocked.",
"type": "string"
},
"business_impact": {
"type": "string"
},
"category_id": {
"description": "Category ID. Null to unassign.",
"type": "string"
},
"checklist": {
"description": "Tick-box checklist shown above acceptance_criteria. The full array REPLACES the stored list on update, and array order = display order — to edit, fetch via getTask/getImprovement, modify, and send back the whole list. Operations: mark done with `completed: true`; un-mark with `completed: false`; add rows by appending `{ text }` (id is auto-minted); remove by omitting; reorder by rearranging. Echo back each existing `id` you keep so per-row attribution (who added/completed it, when) survives.",
"items": {
"properties": {
"completed": {
"description": "true = ticked, false/omitted = not done. Server stamps timestamp + actor.",
"type": "boolean"
},
"completed_at": {
"description": "Server-stamped ISO timestamp. Prefer `completed`; an explicit value here wins if both are sent.",
"type": "string"
},
"completed_by": {
"description": "Server-stamped user id. Echo back unchanged.",
"type": "string"
},
"completed_by_credential_name": {
"description": "Server-stamped credential label. Echo back unchanged.",
"type": "string"
},
"due_date": {
"description": "Optional YYYY-MM-DD; null to clear.",
"type": "string"
},
"id": {
"description": "Optional — server mints one if omitted. Preserve on edits.",
"type": "string"
},
"text": {
"type": "string"
},
"updated_at": {
"description": "Server-stamped. Echo back unchanged; ignored on new rows.",
"type": "string"
},
"updated_by": {
"description": "Server-stamped user id. Echo back unchanged.",
"type": "string"
},
"updated_by_credential_name": {
"description": "Server-stamped credential label. Echo back unchanged.",
"type": "string"
}
},
"required": [
"text"
],
"type": "object"
},
"type": "array"
},
"completion_comment": {
"description": "Required when status=done.",
"type": "string"
},
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"desired_outcome": {
"type": "string"
},
"details": {
"description": "The type's own fields. On update they MERGE key by key: keys you leave out are kept and null removes one. epic: success_measures. user_story: as_a, i_want, so_that (read as 'As a <as_a>, I want <i_want>, so that <so_that>') and story_points. requirement: statement ('The system shall...'), requirement_kind, rationale, source, verification_method. test_case: preconditions, test_steps (ordered { action, expected }), test_data, last_result, last_run_on. spike: question, timebox, findings. An item keeps its details when its type changes.",
"properties": {
"as_a": {
"description": "As a (role or persona)",
"maxLength": 500,
"type": [
"string",
"null"
]
},
"findings": {
"description": "Findings (What was learned, and the recommendation...)",
"maxLength": 20000,
"type": [
"string",
"null"
]
},
"i_want": {
"description": "I want (what they want to do)",
"maxLength": 500,
"type": [
"string",
"null"
]
},
"last_result": {
"description": "Last Result",
"enum": [
"not_run",
"passed",
"failed",
"blocked",
null
],
"type": [
"string",
"null"
]
},
"last_run_on": {
"description": "Last Run, YYYY-MM-DD.",
"type": [
"string",
"null"
]
},
"preconditions": {
"description": "Preconditions (What must be true before the test starts...)",
"maxLength": 20000,
"type": [
"string",
"null"
]
},
"question": {
"description": "Question (What does this spike need to find out?)",
"maxLength": 20000,
"type": [
"string",
"null"
]
},
"rationale": {
"description": "Rationale (Why it is needed...)",
"maxLength": 20000,
"type": [
"string",
"null"
]
},
"requirement_kind": {
"description": "Kind",
"enum": [
"functional",
"non_functional",
"interface",
"data",
"business_rule",
"constraint",
"compliance",
null
],
"type": [
"string",
"null"
]
},
"so_that": {
"description": "So that (the benefit to them)",
"maxLength": 500,
"type": [
"string",
"null"
]
},
"source": {
"description": "Source (A stakeholder, regulation or document)",
"maxLength": 500,
"type": [
"string",
"null"
]
},
"statement": {
"description": "Requirement (The system shall...)",
"maxLength": 20000,
"type": [
"string",
"null"
]
},
"story_points": {
"description": "Story Points (e.g. 3)",
"maximum": 1000,
"minimum": 0,
"type": [
"number",
"null"
]
},
"success_measures": {
"description": "Success Measures (How will you know this epic delivered its outcome?)",
"maxLength": 20000,
"type": [
"string",
"null"
]
},
"test_data": {
"description": "Test Data (Inputs, accounts or records the steps use...)",
"maxLength": 20000,
"type": [
"string",
"null"
]
},
"test_steps": {
"description": "Test Steps, in order. The list you send REPLACES the stored one.",
"items": {
"properties": {
"action": {
"description": "What the tester does.",
"maxLength": 4000,
"type": "string"
},
"expected": {
"description": "What should happen.",
"maxLength": 4000,
"type": "string"
},
"id": {
"description": "Optional; minted if omitted. Echo it back on the steps you keep.",
"maxLength": 64,
"type": "string"
}
},
"type": "object"
},
"maxItems": 200,
"type": [
"array",
"null"
]
},
"timebox": {
"description": "Timebox (e.g. 3 days)",
"maxLength": 500,
"type": [
"string",
"null"
]
},
"verification_method": {
"description": "Verified By",
"enum": [
"test",
"inspection",
"analysis",
"demonstration",
null
],
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"docs_updated": {
"type": "boolean"
},
"end_date": {
"description": "YYYY-MM-DD.",
"type": "string"
},
"fields": {
"description": "Optional. Answer with only these fields instead of the whole improvement, for example [\"id\", \"versionTimestamp\"]. Any of the improvement's own fields (snake_case or camelCase) or of the keys around it in the full answer (versionTimestamp, href and, where present, url, title, trackingId, message). The id is always returned, and so is any notice that needs your attention (a note, such as a phase's dates following its tasks or an item's id changing with its type, and a date change's cascadePreview). Unknown names are ignored.",
"items": {
"maxLength": 64,
"type": "string"
},
"maxItems": 50,
"type": "array"
},
"follow_up_needed": {
"type": "boolean"
},
"impacted_components": {
"items": {
"type": "string"
},
"type": "array"
},
"impacted_diagrams": {
"items": {
"type": "object"
},
"type": "array"
},
"impacted_documents": {
"items": {
"type": "object"
},
"type": "array"
},
"impacted_repositories": {
"items": {
"type": "string"
},
"type": "array"
},
"improvementId": {
"description": "Required unless you send items. The improvement's UUID or friendly id (such as IMP-42).",
"type": "string"
},
"is_task": {
"description": "Mark as task. Prefer setting type='task' instead — is_task is kept in sync from the type enum by a DB trigger.",
"type": "boolean"
},
"items": {
"description": "Optional bulk form: update up to 200 improvements in one call, each entry { improvementId, versionTimestamp, ...the fields to change } with the same fields as a single call. Every entry is checked and written on its own (permission, optimistic lock, audit), so one entry's conflict or error never stops the others. The answer has one row per entry, in your order: { index, id, status: \"updated\", versionTimestamp } or { index, id, status: \"conflict\" or \"failed\", error } (a conflict also carries currentVersionTimestamp), plus summary { requested, updated, failed, conflicts }. With items, send nothing else at the top level except projectId, planId and fields; fields then picks extra fields for each updated row (a row's status is its outcome, so the improvement's own status comes back as improvementStatus).",
"items": {
"properties": {
"acceptance_criteria": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"properties": {
"id": {
"type": "string"
},
"text": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"updated_by": {
"type": "string"
},
"updated_by_credential_name": {
"type": "string"
}
},
"required": [
"text"
],
"type": "object"
}
]
},
"type": "array"
},
"agent_brief": {
"type": "string"
},
"agent_complexity": {
"type": "string"
},
"agent_confidence": {
"type": "number"
},
"agent_missing_info": {
"items": {
"type": "string"
},
"type": "array"
},
"agent_ready": {
"type": "boolean"
},
"agent_recommended_action": {
"type": "string"
},
"blocked_comment": {
"type": "string"
},
"business_impact": {
"type": "string"
},
"category_id": {
"type": "string"
},
"checklist": {
"items": {
"properties": {
"completed": {
"type": "boolean"
},
"completed_at": {
"type": "string"
},
"completed_by": {
"type": "string"
},
"completed_by_credential_name": {
"type": "string"
},
"due_date": {
"type": "string"
},
"id": {
"type": "string"
},
"text": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"updated_by": {
"type": "string"
},
"updated_by_credential_name": {
"type": "string"
}
},
"required": [
"text"
],
"type": "object"
},
"type": "array"
},
"completion_comment": {
"type": "string"
},
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"desired_outcome": {
"type": "string"
},
"details": {
"properties": {
"as_a": {
"maxLength": 500,
"type": [
"string",
"null"
]
},
"findings": {
"maxLength": 20000,
"type": [
"string",
"null"
]
},
"i_want": {
"maxLength": 500,
"type": [
"string",
"null"
]
},
"last_result": {
"enum": [
"not_run",
"passed",
"failed",
"blocked",
null
],
"type": [
"string",
"null"
]
},
"last_run_on": {
"type": [
"string",
"null"
]
},
"preconditions": {
"maxLength": 20000,
"type": [
"string",
"null"
]
},
"question": {
"maxLength": 20000,
"type": [
"string",
"null"
]
},
"rationale": {
"maxLength": 20000,
"type": [
"string",
"null"
]
},
"requirement_kind": {
"enum": [
"functional",
"non_functional",
"interface",
"data",
"business_rule",
"constraint",
"compliance",
null
],
"type": [
"string",
"null"
]
},
"so_that": {
"maxLength": 500,
"type": [
"string",
"null"
]
},
"source": {
"maxLength": 500,
"type": [
"string",
"null"
]
},
"statement": {
"maxLength": 20000,
"type": [
"string",
"null"
]
},
"story_points": {
"maximum": 1000,
"minimum": 0,
"type": [
"number",
"null"
]
},
"success_measures": {
"maxLength": 20000,
"type": [
"string",
"null"
]
},
"test_data": {
"maxLength": 20000,
"type": [
"string",
"null"
]
},
"test_steps": {
"items": {
"properties": {
"action": {
"maxLength": 4000,
"type": "string"
},
"expected": {
"maxLength": 4000,
"type": "string"
},
"id": {
"maxLength": 64,
"type": "string"
}
},
"type": "object"
},
"maxItems": 200,
"type": [
"array",
"null"
]
},
"timebox": {
"maxLength": 500,
"type": [
"string",
"null"
]
},
"verification_method": {
"enum": [
"test",
"inspection",
"analysis",
"demonstration",
null
],
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"docs_updated": {
"type": "boolean"
},
"end_date": {
"type": "string"
},
"follow_up_needed": {
"type": "boolean"
},
"impacted_components": {
"items": {
"type": "string"
},
"type": "array"
},
"impacted_diagrams": {
"items": {
"type": "object"
},
"type": "array"
},
"impacted_documents": {
"items": {
"type": "object"
},
"type": "array"
},
"impacted_repositories": {
"items": {
"type": "string"
},
"type": "array"
},
"improvementId": {
"type": "string"
},
"is_task": {
"type": "boolean"
},
"linked_document_ids": {
"items": {
"type": "string"
},
"type": "array"
},
"metadata": {
"type": "object"
},
"metadata_replace": {
"type": "boolean"
},
"non_goals": {
"items": {
"type": "string"
},
"type": "array"
},
"owner_id": {
"type": [
"string",
"null"
]
},
"owner_team_id": {
"type": [
"string",
"null"
]
},
"parentItemId": {
"maxLength": 64,
"type": [
"string",
"null"
]
},
"percent_complete": {
"type": "number"
},
"phase_id": {
"type": "string"
},
"plan_id": {
"type": "string"
},
"position": {
"type": "number"
},
"priority": {
"type": "string"
},
"problem_statement": {
"type": "string"
},
"rejection_comment": {
"type": "string"
},
"relationships": {
"type": "object"
},
"reopened_comment": {
"type": "string"
},
"resolution_pr_url": {
"type": "string"
},
"resolution_summary": {
"type": "string"
},
"start_date": {
"type": "string"
},
"status": {
"enum": [
"captured",
"triaging",
"shaped",
"approved",
"ready_for_agent",
"in_progress",
"ready_for_review",
"in_review",
"blocked",
"done",
"rejected",
"deferred"
],
"type": "string"
},
"target_date": {
"type": "string"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"urgency": {
"type": "string"
},
"user_impact": {
"type": "string"
},
"versionTimestamp": {
"type": "number"
},
"wbs_code": {
"type": "string"
},
"why_now": {
"type": "string"
}
},
"required": [
"improvementId",
"versionTimestamp"
],
"type": "object"
},
"maxItems": 200,
"minItems": 1,
"type": "array"
},
"linked_document_ids": {
"description": "Document IDs to link.",
"items": {
"type": "string"
},
"type": "array"
},
"metadata": {
"description": "Free-form JSON. MERGES into the stored object key by key: keys you don't send are left alone, and sending a key with value null deletes it. Send metadata_replace:true to overwrite the whole object instead. (Merging is the default so a partial write can never destroy a sibling key written by another actor.)",
"type": "object"
},
"metadata_replace": {
"description": "Opt out of the metadata merge: true means the object you send REPLACES everything stored, deleting any key you omit. Default false.",
"type": "boolean"
},
"non_goals": {
"items": {
"type": "string"
},
"type": "array"
},
"owner_id": {
"description": "User UUID to assign as owner, or null to unassign. MUTUALLY EXCLUSIVE with owner_team_id — when switching from a user to a team owner, send `owner_id: null` in the same call as `owner_team_id`. Use listAssignablePrincipals(projectId, kind='user', q='…') to look up valid UUIDs.",
"type": [
"string",
"null"
]
},
"owner_team_id": {
"description": "Team UUID to assign as owner, or null to unassign. MUTUALLY EXCLUSIVE with owner_id — when switching from a team to a user owner, send `owner_team_id: null` in the same call as `owner_id`. Use listTeams or listAssignablePrincipals(kind='team') to look up valid UUIDs.",
"type": [
"string",
"null"
]
},
"parentItemId": {
"description": "The work item this one belongs to in the work hierarchy: an epic for a story, a story for its tasks or test cases. Any item in the same project, in any plan or phase. Not the plan outline nesting, which setPlanItemParent sets. Give its UUID or friendly id (such as IMP-12 or TAS-3). Rules: the same project; no loops (an item cannot sit inside its own children); at most 5 levels, counting this item's own children. null removes the parent.",
"maxLength": 64,
"type": [
"string",
"null"
]
},
"percent_complete": {
"description": "Progress percentage (0-100). Null to clear.",
"type": "number"
},
"phase_id": {
"description": "Assign to phase. Null to unassign.",
"type": "string"
},
"planId": {
"description": "Optional. Narrows a friendly-id lookup (such as IMP-42) to one plan, given as the plan's UUID or friendly id (such as PLN-3): the item must be in that plan. It never moves anything (plan_id does that) and is ignored when the id is a UUID.",
"type": "string"
},
"plan_id": {
"description": "Link to plan. Null to unlink.",
"type": "string"
},
"position": {
"type": "number"
},
"priority": {
"type": "string"
},
"problem_statement": {
"type": "string"
},
"projectId": {
"description": "Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID.",
"type": "string"
},
"rejection_comment": {
"description": "Required when status=rejected.",
"type": "string"
},
"relationships": {
"description": "Free-form JSON for logical links: blocks, blocked_by, duplicates, supersedes, relates_to (arrays of item IDs). REPLACES the stored object wholesale — read it first and send the complete set.",
"type": "object"
},
"reopened_comment": {
"description": "Required when moving OUT of a closed status. The closed set is blocked, done, rejected and deferred — note that `blocked` counts as closed, so blocked -> in_progress needs this comment.",
"type": "string"
},
"resolution_pr_url": {
"type": "string"
},
"resolution_summary": {
"type": "string"
},
"start_date": {
"description": "YYYY-MM-DD.",
"type": "string"
},
"status": {
"enum": [
"captured",
"triaging",
"shaped",
"approved",
"ready_for_agent",
"in_progress",
"ready_for_review",
"in_review",
"blocked",
"done",
"rejected",
"deferred"
],
"type": "string"
},
"target_date": {
"type": "string"
},
"title": {
"type": "string"
},
"type": {
"description": "One of: feature (New capability for users); enhancement (An improvement to something that already exists); bug (Something that does not work as it should); tech_debt (Work that makes the system easier and safer to change); architecture_gap (A missing or weak part of the architecture); documentation_gap (Documentation that is missing or out of date); risk (Something that could go wrong, to track and reduce); epic (A large body of work, delivered through several stories, features or tasks); user_story (A need told from a user's view: as a role, I want a goal, so that a benefit); requirement (A condition or capability the solution must meet, stated so it can be verified); test_case (Steps that verify a requirement or story, each with its expected result); spike (Time-boxed research to answer a question before committing to the work); task (A unit of work in a plan). Changing the type keeps everything written on the item, its parent and children included. The id's prefix follows the type (see createImprovement's type) and its number stays, so the id can change (STY-30 becomes IMP-30 when a story becomes a feature): the answer's note then gives the new id, and the old one still resolves.",
"type": "string"
},
"urgency": {
"type": "string"
},
"user_impact": {
"type": "string"
},
"versionTimestamp": {
"description": "Required unless you send items. The item's current versionTimestamp (its updated_at in epoch ms), as listImprovements, getPlan, getImprovement or your last write of it returned.",
"type": "number"
},
"wbs_code": {
"type": "string"
},
"why_now": {
"type": "string"
}
},
"type": "object"
},
"name": "updateImprovement",
"outputSchema": {
"properties": {
"href": {
"description": "Web URL of the resource in the Stable Baseline app.",
"type": "string"
},
"improvement": {
"description": "The improvement after the mutation.",
"type": "object"
},
"versionTimestamp": {
"description": "Milliseconds since epoch. Pass back as `versionTimestamp` on subsequent edit/update calls for optimistic locking.",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Update an improvement category. Cannot modify system categories.",
"inputSchema": {
"properties": {
"categoryId": {
"type": "string"
},
"color": {
"type": "string"
},
"description": {
"type": "string"
},
"icon": {
"type": "string"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"sortOrder": {
"type": "number"
}
},
"required": [
"categoryId"
],
"type": "object"
},
"name": "updateImprovementCategory",
"outputSchema": {
"properties": {
"category": {
"description": "The category after the mutation.",
"type": "object"
},
"href": {
"description": "Web URL of the resource in the Stable Baseline app.",
"type": "string"
},
"versionTimestamp": {
"description": "Milliseconds since epoch. Pass back as `versionTimestamp` on subsequent edit/update calls for optimistic locking.",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Update a comment on an improvement. Requires the comment's updated_at as versionTimestamp.",
"inputSchema": {
"properties": {
"activityId": {
"description": "Activity ID from getImprovement activity array.",
"type": "string"
},
"comment": {
"description": "New comment text.",
"type": "string"
},
"versionTimestamp": {
"description": "Comment's updated_at as Unix ms for optimistic locking.",
"type": "number"
}
},
"required": [
"activityId",
"versionTimestamp",
"comment"
],
"type": "object"
},
"name": "updateImprovementComment",
"outputSchema": {
"properties": {
"comment": {
"type": "object"
}
},
"type": "object"
}
},
{
"description": "Update an organisation member's role (admin or member). Owners cannot be changed via this tool. Refuses self-promotion. Rate limit 30/min. Use when the user asks to promote someone to admin, demote an admin to member, or change a teammate's role.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"organisation_id": {
"description": "Organisation UUID. Must match the credential's organisation.",
"type": "string"
},
"organization_role": {
"enum": [
"member",
"admin"
],
"type": "string"
},
"user_id": {
"description": "Target user UUID.",
"type": "string"
}
},
"required": [
"organisation_id",
"user_id",
"organization_role"
],
"type": "object"
},
"name": "updateMemberRole",
"outputSchema": {
"type": "object"
}
},
{
"description": "Toggle organisation feature modules (plans, improvements, compliance, knowledge_graph, documents, meeting_scribe). Auth: can_admin_org + org admin. Rate limit 30/min. A flag can only be ENABLED when the feature is available to the organisation — included in its plan (knowledge_graph and compliance need Enterprise, meeting_scribe needs Pro or Enterprise) or granted by a platform administrator. Disabling is always allowed. Disabled modules hide their tools and app pages.",
"inputSchema": {
"properties": {
"compliance": {
"type": "boolean"
},
"documents": {
"type": "boolean"
},
"improvements": {
"type": "boolean"
},
"knowledge_graph": {
"type": "boolean"
},
"meeting_scribe": {
"type": "boolean"
},
"organisation_id": {
"type": "string"
},
"plans": {
"type": "boolean"
}
},
"required": [
"organisation_id"
],
"type": "object"
},
"name": "updateOrgFeatureFlags",
"outputSchema": {
"properties": {
"enabled_features": {
"type": "object"
}
},
"type": "object"
}
},
{
"description": "Update an organisation's `settings` JSONB via deep merge. Auth: ceiling — credential must hold can_admin_org AND user must be org owner/admin. Rate limit 30/min. Patches that touch `enabledFeatures` are rejected — use updateOrgFeatureFlags instead.",
"inputSchema": {
"properties": {
"organisation_id": {
"type": "string"
},
"settings": {
"additionalProperties": true,
"description": "JSONB patch — top-level keys deep-merged with existing settings; null removes a key. enabledFeatures is rejected.",
"type": "object"
}
},
"required": [
"organisation_id",
"settings"
],
"type": "object"
},
"name": "updateOrgSettings",
"outputSchema": {
"properties": {
"settings": {
"type": "object"
}
},
"type": "object"
}
},
{
"description": "Update an organisation's name and/or description. Auth: ceiling — credential must hold `can_admin_org` capability AND user must be org owner/admin. Rate limit 30/min. At least one of name/description required. Returns updated row.",
"inputSchema": {
"properties": {
"description": {
"maxLength": 2000,
"type": [
"string",
"null"
]
},
"name": {
"maxLength": 200,
"minLength": 1,
"type": "string"
},
"organisation_id": {
"description": "Organisation UUID. Must equal the credential's organisation.",
"type": "string"
}
},
"required": [
"organisation_id"
],
"type": "object"
},
"name": "updateOrganisation",
"outputSchema": {
"properties": {
"href": {
"description": "Web URL of the resource in the Stable Baseline app.",
"type": "string"
},
"organisation": {
"description": "The organisation after the mutation.",
"type": "object"
},
"versionTimestamp": {
"description": "Milliseconds since epoch. Pass back as `versionTimestamp` on subsequent edit/update calls for optimistic locking.",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Update a plan. versionTimestamp (optimistic locking) is the plan's updated_at in epoch milliseconds: listPlans and getPlan return it, and every write returns the new one. Pass `fields` (for example [\"id\", \"versionTimestamp\"]) for a short answer instead of the whole plan.",
"inputSchema": {
"properties": {
"color": {
"type": "string"
},
"description": {
"type": "string"
},
"end_date": {
"description": "YYYY-MM-DD.",
"type": "string"
},
"fields": {
"description": "Optional. Answer with only these fields instead of the whole plan, for example [\"id\", \"versionTimestamp\"]. Any of the plan's own fields (snake_case or camelCase) or of the keys around it in the full answer (versionTimestamp, href and, where present, url, title, trackingId, message). The id is always returned, and so is any notice that needs your attention (a note, such as a phase's dates following its tasks or an item's id changing with its type, and a date change's cascadePreview). Unknown names are ignored.",
"items": {
"maxLength": 64,
"type": "string"
},
"maxItems": 50,
"type": "array"
},
"icon": {
"type": "string"
},
"linked_document_ids": {
"description": "Document IDs to link.",
"items": {
"type": "string"
},
"type": "array"
},
"linked_documents": {
"items": {
"type": "object"
},
"type": "array"
},
"metadata": {
"type": "object"
},
"planId": {
"type": "string"
},
"priority": {
"description": "Priority: low, medium, high, critical.",
"type": "string"
},
"projectId": {
"description": "Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID.",
"type": "string"
},
"start_date": {
"description": "YYYY-MM-DD.",
"type": "string"
},
"status": {
"description": "Status: draft, planning, active, on_hold, completed, cancelled.",
"type": "string"
},
"title": {
"type": "string"
},
"versionTimestamp": {
"description": "The plan's current versionTimestamp (its updated_at in epoch ms), as listPlans, getPlan or your last write of it returned.",
"type": "number"
}
},
"required": [
"planId",
"versionTimestamp"
],
"type": "object"
},
"name": "updatePlan",
"outputSchema": {
"properties": {
"href": {
"description": "Web URL of the resource in the Stable Baseline app.",
"type": "string"
},
"plan": {
"description": "The plan after the mutation.",
"type": "object"
},
"versionTimestamp": {
"description": "Milliseconds since epoch. Pass back as `versionTimestamp` on subsequent edit/update calls for optimistic locking.",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Update a comment on a plan. Requires the comment's updated_at as versionTimestamp.",
"inputSchema": {
"properties": {
"activityId": {
"description": "Activity ID from getPlan activity array.",
"type": "string"
},
"comment": {
"description": "New comment text.",
"type": "string"
},
"versionTimestamp": {
"description": "Comment's updated_at as Unix ms for optimistic locking.",
"type": "number"
}
},
"required": [
"activityId",
"versionTimestamp",
"comment"
],
"type": "object"
},
"name": "updatePlanComment",
"outputSchema": {
"properties": {
"comment": {
"type": "object"
}
},
"type": "object"
}
},
{
"description": "Update a plan phase, or many phases in one call. Each phase has its own versionTimestamp (its updated_at in epoch milliseconds): listPlanPhases and getPlan (phases[].versionTimestamp) return it for every phase in a plan, getPlanPhase for one, and every write returns the new one. Never pass the plan's own top-level versionTimestamp. A phase with date_mode 'auto' (the default) takes its dates from its tasks; set date_mode 'manual' to pin dates by hand, or 'auto' to make them follow the tasks again. Pass `fields` (for example [\"id\", \"versionTimestamp\"]) for a short answer; a `note` saying the dates were replaced by the tasks' range always comes back. To change many phases, send `items`: up to 200 entries of { phaseId, versionTimestamp, ...changes } per call (more than 200: split them into several calls of up to 200), each checked and written on its own and answered with one row per entry plus a summary.",
"inputSchema": {
"properties": {
"color": {
"description": "Phase color. Must be one of: #3b82f6 (Blue), #f59e0b (Amber), #8b5cf6 (Purple), #ec4899 (Pink), #06b6d4 (Cyan), #14b8a6 (Teal), #6366f1 (Indigo), #6b7280 (Gray). Red and green are reserved for blocked / done item statuses. Pass null to clear.",
"enum": [
"#3b82f6",
"#f59e0b",
"#8b5cf6",
"#ec4899",
"#06b6d4",
"#14b8a6",
"#6366f1",
"#6b7280",
null
],
"type": [
"string",
"null"
]
},
"date_mode": {
"description": "auto: the phase's dates follow its tasks (earliest task start to latest task end, kept current). manual: the dates you set are kept. Switching to auto recomputes the dates at once when the phase has dated tasks.",
"enum": [
"auto",
"manual"
],
"type": "string"
},
"description": {
"type": "string"
},
"end_date": {
"description": "YYYY-MM-DD on or after start_date, or null to clear. While date_mode is 'auto' and the phase has dated tasks, the tasks' range wins and the reply carries a note saying so; send date_mode 'manual' with it to set it by hand.",
"type": [
"string",
"null"
]
},
"fields": {
"description": "Optional. Answer with only these fields instead of the whole phase, for example [\"id\", \"versionTimestamp\"]. Any of the phase's own fields (snake_case or camelCase) or of the keys around it in the full answer (versionTimestamp, href and, where present, url, title, trackingId, message). The id is always returned, and so is any notice that needs your attention (a note, such as a phase's dates following its tasks or an item's id changing with its type, and a date change's cascadePreview). Unknown names are ignored.",
"items": {
"maxLength": 64,
"type": "string"
},
"maxItems": 50,
"type": "array"
},
"items": {
"description": "Optional bulk form: update up to 200 phases in one call, each entry { phaseId, versionTimestamp, ...the fields to change } with the same fields as a single call. Every entry is checked and written on its own (permission, optimistic lock, audit), so one entry's conflict or error never stops the others. The answer has one row per entry, in your order: { index, id, status: \"updated\", versionTimestamp } or { index, id, status: \"conflict\" or \"failed\", error } (a conflict also carries currentVersionTimestamp), plus summary { requested, updated, failed, conflicts }. With items, send nothing else at the top level except projectId, planId and fields; fields then picks extra fields for each updated row (a row's status is its outcome, so the phase's own status comes back as phaseStatus).",
"items": {
"properties": {
"color": {
"enum": [
"#3b82f6",
"#f59e0b",
"#8b5cf6",
"#ec4899",
"#06b6d4",
"#14b8a6",
"#6366f1",
"#6b7280",
null
],
"type": [
"string",
"null"
]
},
"date_mode": {
"enum": [
"auto",
"manual"
],
"type": "string"
},
"description": {
"type": "string"
},
"end_date": {
"type": [
"string",
"null"
]
},
"name": {
"type": "string"
},
"phaseId": {
"type": "string"
},
"position": {
"type": "number"
},
"priority": {
"type": "string"
},
"start_date": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string"
},
"versionTimestamp": {
"type": "number"
},
"wbs_code": {
"type": "string"
}
},
"required": [
"phaseId",
"versionTimestamp"
],
"type": "object"
},
"maxItems": 200,
"minItems": 1,
"type": "array"
},
"name": {
"type": "string"
},
"phaseId": {
"description": "Required unless you send items. The phase's UUID or friendly id (such as PHA-7); with a friendly id, give planId too, since PHA- ids repeat in every plan.",
"type": "string"
},
"planId": {
"description": "Optional. Narrows a friendly-id lookup to one plan, given as the plan's UUID or friendly id (such as PLN-3). Phase ids are numbered per plan, so PHA-2 exists in every plan and planId is what makes one unique. Ignored when phaseId is a UUID.",
"type": "string"
},
"position": {
"type": "number"
},
"priority": {
"description": "Priority: low, medium, high, critical.",
"type": "string"
},
"projectId": {
"description": "Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID.",
"type": "string"
},
"start_date": {
"description": "YYYY-MM-DD, or null to clear. While date_mode is 'auto' and the phase has dated tasks, the tasks' range wins and the reply carries a note saying so; send date_mode 'manual' with it to set it by hand.",
"type": [
"string",
"null"
]
},
"status": {
"description": "Status: not_started, in_progress, completed, on_hold, cancelled.",
"type": "string"
},
"versionTimestamp": {
"description": "Required unless you send items. The phase's own current versionTimestamp (its updated_at in epoch ms), as listPlanPhases, getPlan (phases[].versionTimestamp), getPlanPhase or your last write of it returned. Not the plan's.",
"type": "number"
},
"wbs_code": {
"type": "string"
}
},
"type": "object"
},
"name": "updatePlanPhase",
"outputSchema": {
"properties": {
"href": {
"description": "Web URL of the resource in the Stable Baseline app.",
"type": "string"
},
"phase": {
"description": "The phase after the mutation.",
"type": "object"
},
"versionTimestamp": {
"description": "Milliseconds since epoch. Pass back as `versionTimestamp` on subsequent edit/update calls for optimistic locking.",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Update a user's profile name and/or display email. Self-updates do not require organisation_id; updates to other users require organisation_id and the can_manage_members capability. Self login-email changes must be done via the UI (verification round-trip).",
"inputSchema": {
"additionalProperties": false,
"properties": {
"email": {
"maxLength": 320,
"type": "string"
},
"name": {
"maxLength": 200,
"minLength": 1,
"type": "string"
},
"organisation_id": {
"description": "Required when editing another user.",
"type": "string"
},
"user_id": {
"type": "string"
}
},
"required": [
"user_id"
],
"type": "object"
},
"name": "updateProfile",
"outputSchema": {
"properties": {
"profile": {
"type": "object"
}
},
"type": "object"
}
},
{
"description": "Update a project's name, description, and/or icon. Mirrors the UI Project General Settings page. Auth: admin on the project (cascades from workspace owner/admin and org admin). Partial updates; at least one of name/description/icon must be supplied. Rate limit 60/min.",
"inputSchema": {
"properties": {
"description": {
"description": "Pass null to clear.",
"maxLength": 2000,
"type": [
"string",
"null"
]
},
"icon": {
"description": "Pass null to clear.",
"maxLength": 32,
"type": [
"string",
"null"
]
},
"name": {
"maxLength": 200,
"minLength": 1,
"type": "string"
},
"project_id": {
"description": "Project UUID.",
"type": "string"
}
},
"required": [
"project_id"
],
"type": "object"
},
"name": "updateProject",
"outputSchema": {
"properties": {
"href": {
"description": "Web URL of the resource in the Stable Baseline app.",
"type": "string"
},
"project": {
"description": "The project after the mutation.",
"type": "object"
},
"versionTimestamp": {
"description": "Milliseconds since epoch. Pass back as `versionTimestamp` on subsequent edit/update calls for optimistic locking.",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Update the access level on an existing permission row. Override flags are NOT touched — use setResourcePermissionOverride for those. Refuses self-escalation. Rate limit 30/min.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"level": {
"enum": [
"none",
"read",
"write",
"admin"
],
"type": "string"
},
"permission_id": {
"description": "UUID of the resource_permissions row",
"type": "string"
}
},
"required": [
"permission_id",
"level"
],
"type": "object"
},
"name": "updateResourcePermission",
"outputSchema": {
"properties": {
"permission": {
"type": "object"
}
},
"type": "object"
}
},
{
"description": "Update a task, or many tasks in one call. Tasks share a row with improvements (`improvement_items` with `is_task=true`), so this is a thin alias over updateImprovement: every field on updateImprovement is supported, including `checklist`, `acceptance_criteria`, dates, owner, percent_complete, parentItemId (the story or requirement it belongs to in the work hierarchy), etc. versionTimestamp (optimistic locking) is the task's updated_at in epoch milliseconds, and you rarely need a getTask call for it: listTasks and getPlan (items[].versionTimestamp) return it for every task in a plan at once, and every write returns the task's new one. Pass `fields` (for example [\"id\", \"versionTimestamp\"]) for a short answer instead of the whole task. To change many tasks (a plan-wide re-date, say), send `items`: up to 200 entries of { taskId, versionTimestamp, ...changes } per call (more than 200: split them into several calls of up to 200), each checked and written on its own and answered with one row per entry plus a summary. Statuses are captured / in_progress / blocked / done / rejected / deferred, and FOUR of those are CLOSED: blocked, done, rejected, deferred. Entering one needs its comment (blocked_comment / rejection_comment / completion_comment); leaving one for an open status needs reopened_comment, including blocked -> in_progress, which surprises people because `blocked` does not sound terminal. `metadata` MERGES into what is stored (null on a key deletes it); pass metadata_replace:true to overwrite the object wholesale. To edit checklist items: call getTask, modify the `checklist` array (preserving each row's `id` to keep its attribution stamps), and pass the full array back here; array order is the sort order. Assignment: pass `owner_id=<uuid>` to assign to a user, `owner_team_id=<uuid>` to assign to a team (mutually exclusive: the DB enforces it with a CHECK constraint). To unassign, pass `owner_id=null` AND `owner_team_id=null`. To switch owner kind, send the new value AND null the old one in the SAME call.",
"inputSchema": {
"properties": {
"acceptance_criteria": {
"description": "Acceptance criteria — ordered list of pass/fail statements that define \"done\" for this item. Each row is `{ id, text }` with server-stamped `updated_at / updated_by / updated_by_credential_name`. REPLACES the whole array on update. Echo back existing `id`s on rows you keep so attribution stamps survive. Bare strings are accepted for convenience (e.g. `[\"row 1\", \"row 2\"]`) and auto-converted to `{ id, text }`.",
"items": {
"anyOf": [
{
"description": "Shorthand for `{ text: \"...\" }`.",
"type": "string"
},
{
"properties": {
"id": {
"description": "Optional — server mints one if omitted. Preserve on edits.",
"type": "string"
},
"text": {
"type": "string"
},
"updated_at": {
"description": "Server-stamped. Echo back unchanged; ignored on new rows.",
"type": "string"
},
"updated_by": {
"description": "Server-stamped user id. Echo back unchanged.",
"type": "string"
},
"updated_by_credential_name": {
"description": "Server-stamped credential label. Echo back unchanged.",
"type": "string"
}
},
"required": [
"text"
],
"type": "object"
}
]
},
"type": "array"
},
"agent_brief": {
"type": "string"
},
"agent_complexity": {
"type": "string"
},
"agent_confidence": {
"type": "number"
},
"agent_missing_info": {
"items": {
"type": "string"
},
"type": "array"
},
"agent_ready": {
"type": "boolean"
},
"agent_recommended_action": {
"type": "string"
},
"blocked_comment": {
"description": "Required when status=blocked.",
"type": "string"
},
"business_impact": {
"type": "string"
},
"checklist": {
"description": "Tick-box checklist shown above acceptance_criteria. The full array REPLACES the stored list on update, and array order = display order — to edit, fetch via getTask/getImprovement, modify, and send back the whole list. Operations: mark done with `completed: true`; un-mark with `completed: false`; add rows by appending `{ text }` (id is auto-minted); remove by omitting; reorder by rearranging. Echo back each existing `id` you keep so per-row attribution (who added/completed it, when) survives.",
"items": {
"properties": {
"completed": {
"description": "true = ticked, false/omitted = not done. Server stamps timestamp + actor.",
"type": "boolean"
},
"completed_at": {
"description": "Server-stamped ISO timestamp. Prefer `completed`; an explicit value here wins if both are sent.",
"type": "string"
},
"completed_by": {
"description": "Server-stamped user id. Echo back unchanged.",
"type": "string"
},
"completed_by_credential_name": {
"description": "Server-stamped credential label. Echo back unchanged.",
"type": "string"
},
"due_date": {
"description": "Optional YYYY-MM-DD; null to clear.",
"type": "string"
},
"id": {
"description": "Optional — server mints one if omitted. Preserve on edits.",
"type": "string"
},
"text": {
"type": "string"
},
"updated_at": {
"description": "Server-stamped. Echo back unchanged; ignored on new rows.",
"type": "string"
},
"updated_by": {
"description": "Server-stamped user id. Echo back unchanged.",
"type": "string"
},
"updated_by_credential_name": {
"description": "Server-stamped credential label. Echo back unchanged.",
"type": "string"
}
},
"required": [
"text"
],
"type": "object"
},
"type": "array"
},
"completion_comment": {
"description": "Required when status=done.",
"type": "string"
},
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"desired_outcome": {
"type": "string"
},
"docs_updated": {
"type": "boolean"
},
"end_date": {
"description": "YYYY-MM-DD.",
"type": "string"
},
"fields": {
"description": "Optional. Answer with only these fields instead of the whole task, for example [\"id\", \"versionTimestamp\"]. Any of the task's own fields (snake_case or camelCase) or of the keys around it in the full answer (versionTimestamp, href and, where present, url, title, trackingId, message). The id is always returned, and so is any notice that needs your attention (a note, such as a phase's dates following its tasks or an item's id changing with its type, and a date change's cascadePreview). Unknown names are ignored.",
"items": {
"maxLength": 64,
"type": "string"
},
"maxItems": 50,
"type": "array"
},
"follow_up_needed": {
"type": "boolean"
},
"impacted_components": {
"items": {
"type": "string"
},
"type": "array"
},
"impacted_diagrams": {
"items": {
"type": "object"
},
"type": "array"
},
"impacted_documents": {
"items": {
"type": "object"
},
"type": "array"
},
"impacted_repositories": {
"items": {
"type": "string"
},
"type": "array"
},
"items": {
"description": "Optional bulk form: update up to 200 tasks in one call, each entry { taskId, versionTimestamp, ...the fields to change } with the same fields as a single call. Every entry is checked and written on its own (permission, optimistic lock, audit), so one entry's conflict or error never stops the others. The answer has one row per entry, in your order: { index, id, status: \"updated\", versionTimestamp } or { index, id, status: \"conflict\" or \"failed\", error } (a conflict also carries currentVersionTimestamp), plus summary { requested, updated, failed, conflicts }. With items, send nothing else at the top level except projectId, planId and fields; fields then picks extra fields for each updated row (a row's status is its outcome, so the task's own status comes back as taskStatus).",
"items": {
"properties": {
"acceptance_criteria": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"properties": {
"id": {
"type": "string"
},
"text": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"updated_by": {
"type": "string"
},
"updated_by_credential_name": {
"type": "string"
}
},
"required": [
"text"
],
"type": "object"
}
]
},
"type": "array"
},
"agent_brief": {
"type": "string"
},
"agent_complexity": {
"type": "string"
},
"agent_confidence": {
"type": "number"
},
"agent_missing_info": {
"items": {
"type": "string"
},
"type": "array"
},
"agent_ready": {
"type": "boolean"
},
"agent_recommended_action": {
"type": "string"
},
"blocked_comment": {
"type": "string"
},
"business_impact": {
"type": "string"
},
"checklist": {
"items": {
"properties": {
"completed": {
"type": "boolean"
},
"completed_at": {
"type": "string"
},
"completed_by": {
"type": "string"
},
"completed_by_credential_name": {
"type": "string"
},
"due_date": {
"type": "string"
},
"id": {
"type": "string"
},
"text": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"updated_by": {
"type": "string"
},
"updated_by_credential_name": {
"type": "string"
}
},
"required": [
"text"
],
"type": "object"
},
"type": "array"
},
"completion_comment": {
"type": "string"
},
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"desired_outcome": {
"type": "string"
},
"docs_updated": {
"type": "boolean"
},
"end_date": {
"type": "string"
},
"follow_up_needed": {
"type": "boolean"
},
"impacted_components": {
"items": {
"type": "string"
},
"type": "array"
},
"impacted_diagrams": {
"items": {
"type": "object"
},
"type": "array"
},
"impacted_documents": {
"items": {
"type": "object"
},
"type": "array"
},
"impacted_repositories": {
"items": {
"type": "string"
},
"type": "array"
},
"linked_document_ids": {
"items": {
"type": "string"
},
"type": "array"
},
"metadata": {
"type": "object"
},
"metadata_replace": {
"type": "boolean"
},
"non_goals": {
"items": {
"type": "string"
},
"type": "array"
},
"owner_id": {
"type": [
"string",
"null"
]
},
"owner_team_id": {
"type": [
"string",
"null"
]
},
"parentItemId": {
"maxLength": 64,
"type": [
"string",
"null"
]
},
"percent_complete": {
"type": "number"
},
"phase_id": {
"type": "string"
},
"plan_id": {
"type": "string"
},
"position": {
"type": "number"
},
"priority": {
"type": "string"
},
"problem_statement": {
"type": "string"
},
"rejection_comment": {
"type": "string"
},
"relationships": {
"type": "object"
},
"reopened_comment": {
"type": "string"
},
"resolution_pr_url": {
"type": "string"
},
"resolution_summary": {
"type": "string"
},
"start_date": {
"type": "string"
},
"status": {
"enum": [
"captured",
"triaging",
"shaped",
"approved",
"ready_for_agent",
"in_progress",
"ready_for_review",
"in_review",
"blocked",
"done",
"rejected",
"deferred"
],
"type": "string"
},
"target_date": {
"type": "string"
},
"taskId": {
"type": "string"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"urgency": {
"type": "string"
},
"user_impact": {
"type": "string"
},
"versionTimestamp": {
"type": "number"
},
"wbs_code": {
"type": "string"
},
"why_now": {
"type": "string"
}
},
"required": [
"taskId",
"versionTimestamp"
],
"type": "object"
},
"maxItems": 200,
"minItems": 1,
"type": "array"
},
"linked_document_ids": {
"description": "Document IDs to link.",
"items": {
"type": "string"
},
"type": "array"
},
"metadata": {
"description": "Free-form JSON. MERGES into the stored object key by key: keys you don't send are left alone, and sending a key with value null deletes it. Send metadata_replace:true to overwrite the whole object instead. (Merging is the default so a partial write can never destroy a sibling key written by another actor.)",
"type": "object"
},
"metadata_replace": {
"description": "Opt out of the metadata merge: true means the object you send REPLACES everything stored, deleting any key you omit. Default false.",
"type": "boolean"
},
"non_goals": {
"items": {
"type": "string"
},
"type": "array"
},
"owner_id": {
"description": "User UUID to assign as owner, or null to unassign. MUTUALLY EXCLUSIVE with owner_team_id — when switching from a user to a team owner, send `owner_id: null` in the same call as `owner_team_id`. Use listAssignablePrincipals(projectId, kind='user', q='…') to look up valid UUIDs.",
"type": [
"string",
"null"
]
},
"owner_team_id": {
"description": "Team UUID to assign as owner, or null to unassign. MUTUALLY EXCLUSIVE with owner_id — when switching from a team to a user owner, send `owner_team_id: null` in the same call as `owner_id`. Use listTeams or listAssignablePrincipals(kind='team') to look up valid UUIDs.",
"type": [
"string",
"null"
]
},
"parentItemId": {
"description": "The work item this one belongs to in the work hierarchy: an epic for a story, a story for its tasks or test cases. Any item in the same project, in any plan or phase. Not the plan outline nesting, which setPlanItemParent sets. Give its UUID or friendly id (such as IMP-12 or TAS-3). Rules: the same project; no loops (an item cannot sit inside its own children); at most 5 levels, counting this item's own children. null removes the parent.",
"maxLength": 64,
"type": [
"string",
"null"
]
},
"percent_complete": {
"description": "Progress percentage (0-100). Null to clear.",
"type": "number"
},
"phase_id": {
"description": "Assign to phase. Null to unassign.",
"type": "string"
},
"planId": {
"description": "Optional. Narrows a friendly-id lookup (such as TAS-55) to one plan, given as the plan's UUID or friendly id (such as PLN-3): the task must be in that plan. It never moves anything (plan_id does that) and is ignored when the id is a UUID.",
"type": "string"
},
"plan_id": {
"description": "Link to plan. Null to unlink.",
"type": "string"
},
"position": {
"type": "number"
},
"priority": {
"type": "string"
},
"problem_statement": {
"type": "string"
},
"projectId": {
"description": "Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID.",
"type": "string"
},
"rejection_comment": {
"description": "Required when status=rejected.",
"type": "string"
},
"relationships": {
"description": "Free-form JSON for logical links: blocks, blocked_by, duplicates, supersedes, relates_to (arrays of item IDs). REPLACES the stored object wholesale — read it first and send the complete set.",
"type": "object"
},
"reopened_comment": {
"description": "Required when moving OUT of a closed status. The closed set is blocked, done, rejected and deferred — note that `blocked` counts as closed, so blocked -> in_progress needs this comment.",
"type": "string"
},
"resolution_pr_url": {
"type": "string"
},
"resolution_summary": {
"type": "string"
},
"start_date": {
"description": "YYYY-MM-DD.",
"type": "string"
},
"status": {
"enum": [
"captured",
"triaging",
"shaped",
"approved",
"ready_for_agent",
"in_progress",
"ready_for_review",
"in_review",
"blocked",
"done",
"rejected",
"deferred"
],
"type": "string"
},
"target_date": {
"description": "YYYY-MM-DD.",
"type": "string"
},
"taskId": {
"description": "Required unless you send items. The task's UUID or friendly id (such as TAS-55).",
"type": "string"
},
"title": {
"type": "string"
},
"type": {
"description": "Changing the type converts the task and its id takes the new type's prefix, keeping its number (TAS-12 becomes STY-12 as a user_story): the answer's note then gives the new id, and the old one still resolves.",
"type": "string"
},
"urgency": {
"type": "string"
},
"user_impact": {
"type": "string"
},
"versionTimestamp": {
"description": "Required unless you send items. The task's current versionTimestamp (its updated_at in epoch ms), as listTasks, getPlan, getTask or your last write of it returned.",
"type": "number"
},
"wbs_code": {
"type": "string"
},
"why_now": {
"type": "string"
}
},
"type": "object"
},
"name": "updateTask",
"outputSchema": {
"properties": {
"href": {
"description": "Web URL of the resource in the Stable Baseline app.",
"type": "string"
},
"task": {
"description": "The task after the mutation.",
"type": "object"
},
"versionTimestamp": {
"description": "Milliseconds since epoch. Pass back as `versionTimestamp` on subsequent edit/update calls for optimistic locking.",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Change the type (FS/SS/FF) or lag/lead of an existing task-dependency. Doesn't move dates directly; flags the successor with `needs_dependency_review=true` and fills `suggested_start_date`/`suggested_end_date` if the change implies a different schedule.",
"inputSchema": {
"properties": {
"dependencyId": {
"type": "string"
},
"dependencyType": {
"enum": [
"FS",
"SS",
"FF"
],
"type": "string"
},
"lagDays": {
"description": "Positive = lag, negative = lead.",
"type": "integer"
}
},
"required": [
"dependencyId"
],
"type": "object"
},
"name": "updateTaskDependency",
"outputSchema": {
"properties": {
"dependency": {
"description": "The dependency after the mutation.",
"type": "object"
},
"href": {
"description": "Web URL of the resource in the Stable Baseline app.",
"type": "string"
},
"versionTimestamp": {
"description": "Milliseconds since epoch. Pass back as `versionTimestamp` on subsequent edit/update calls for optimistic locking.",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Update a team's name, description, and/or colour. At least one field required. Slug is intentionally not editable. Rate limit 60/min.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"color": {
"pattern": "^#[0-9a-fA-F]{6}$",
"type": "string"
},
"description": {
"maxLength": 2000,
"type": [
"string",
"null"
]
},
"name": {
"maxLength": 200,
"minLength": 1,
"type": "string"
},
"team_id": {
"type": "string"
}
},
"required": [
"team_id"
],
"type": "object"
},
"name": "updateTeam",
"outputSchema": {
"properties": {
"href": {
"description": "Web URL of the resource in the Stable Baseline app.",
"type": "string"
},
"team": {
"description": "The team after the mutation.",
"type": "object"
},
"versionTimestamp": {
"description": "Milliseconds since epoch. Pass back as `versionTimestamp` on subsequent edit/update calls for optimistic locking.",
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Update an existing team's workspace access level. Refuses if no grant exists — call grantTeamWorkspaceAccess first. No-op when level matches.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"permission_level": {
"enum": [
"read",
"write",
"admin"
],
"type": "string"
},
"team_id": {
"type": "string"
},
"workspace_id": {
"type": "string"
}
},
"required": [
"team_id",
"workspace_id",
"permission_level"
],
"type": "object"
},
"name": "updateTeamWorkspaceAccess",
"outputSchema": {
"properties": {
"access": {
"type": "object"
}
},
"type": "object"
}
},
{
"description": "Update the calling user's preferences. Self-only. Rate limit 60/min. Partial: only fields supplied are updated. notifications upserts a single row; grids upserts per-row keyed by (user_id, project_id, grid_key, view_name).",
"inputSchema": {
"properties": {
"grids": {
"items": {
"properties": {
"column_order": {
"description": "Ordered column ids (string[]) when an array.",
"items": {
"type": "string"
},
"type": [
"object",
"array",
"null"
]
},
"column_widths": {
"description": "Column widths — a { colId: px } map, or a number[] when an array.",
"items": {
"type": "number"
},
"type": [
"object",
"array",
"null"
]
},
"filter_config": {
"description": "Filter state — usually a { pageSize, tab, filters } object.",
"items": {
"type": "object"
},
"type": [
"object",
"array",
"null"
]
},
"grid_key": {
"type": "string"
},
"is_default": {
"type": "boolean"
},
"project_id": {
"type": "string"
},
"sort_config": {
"description": "Sort rules — array of { id, desc } when an array.",
"items": {
"type": "object"
},
"type": [
"object",
"array",
"null"
]
},
"view_name": {
"description": "Defaults to 'default'",
"type": "string"
},
"visible_columns": {
"description": "Visible column ids (string[]) when an array.",
"items": {
"type": "string"
},
"type": [
"object",
"array",
"null"
]
}
},
"required": [
"project_id",
"grid_key"
],
"type": "object"
},
"type": "array"
},
"notifications": {
"additionalProperties": false,
"properties": {
"email_credit_reset": {
"type": "boolean"
},
"email_low_credits": {
"type": "boolean"
},
"email_payment_failed": {
"type": "boolean"
},
"email_subscription_updates": {
"type": "boolean"
},
"in_app_low_credits": {
"type": "boolean"
},
"in_app_payment_updates": {
"type": "boolean"
},
"low_credit_threshold": {
"type": [
"integer",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"name": "updateUserPreferences",
"outputSchema": {
"properties": {
"preferences": {
"type": "object"
}
},
"type": "object"
}
},
{
"description": "Edit elements on a whiteboard's canvas WITHOUT dropping the rest of the scene. A board may hold many diagrams/elements, so prefer surgical edits: mode='patch' (DEFAULT) shallow-merges each incoming object into the existing element with the same `id` (send just {id, backgroundColor:'blue'} to recolour one box, or {id, x, y} to move one) and appends any elements whose id is new/absent — everything else is left untouched. `deleteIds` removes specific elements by id. mode='append' only adds. mode='replace' overwrites the ENTIRE scene — to rebuild or edit only PART of a board, still use 'patch', because replace DELETES every element you don't resend (of ANY type). As a safeguard, a replace that would drop ANY existing element not in your payload is REJECTED unless you pass confirmReplace:true (or include those ids); diagrams/images/frames are flagged specially since they're inserted separately and costliest to lose. To author NEW shapes/connectors from a high-level spec, prefer addWhiteboardElements — and prefer library stencils / sticky notes / architecture icons over plain rectangles wherever a standard form fits (sticky notes, kanban/scrum, flowcharts, UML/ER, BPMN, org charts, wireframes). Optional appState/files are merged in. PROCESS: for a non-trivial edit call getWhiteboardGuide FIRST; after editing, ALWAYS call getWhiteboardImage to confirm the board still looks right (layout, labels, overlaps), and patch again if it doesn't.",
"inputSchema": {
"properties": {
"appState": {
"description": "Optional Excalidraw appState fields to merge (e.g. viewBackgroundColor).",
"type": "object"
},
"confirmReplace": {
"description": "Safety acknowledgement for mode 'replace' ONLY. A replace that would DELETE ANY existing element not present in your `elements` is rejected unless this is true. Leave it unset and use mode:'patch' to edit part of a board (it merges by id and keeps the rest); set true only when you truly intend to overwrite the WHOLE scene.",
"type": "boolean"
},
"deleteIds": {
"description": "Element ids to remove from the scene.",
"items": {
"type": "string"
},
"type": "array"
},
"documentId": {
"type": "string"
},
"elements": {
"description": "Elements to write. For mode 'patch', each may be a partial { id, ...changedFields } merged into the matching element by id; full Excalidraw elements for 'replace'/'append' (or new ids in 'patch').",
"items": {
"type": "object"
},
"type": "array"
},
"files": {
"description": "Optional Excalidraw BinaryFiles map (for embedded images), merged in.",
"type": "object"
},
"mode": {
"description": "How to apply your `elements`. patch (DEFAULT — use this for ANY partial edit): merges each item into the element with the same id and leaves everything else untouched, like find-and-replace by id; new ids are added. append: only adds your items, changes nothing else. replace: OVERWRITES THE WHOLE CANVAS — every existing element you don't resend is DELETED — so use it ONLY to set an entire board at once. To change or rebuild just a SECTION, use patch (+ deleteIds to remove specific ids), NEVER replace. A replace that would drop any existing element is rejected unless confirmReplace:true.",
"enum": [
"patch",
"append",
"replace"
],
"type": "string"
},
"projectId": {
"description": "Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID.",
"type": "string"
},
"versionTimestamp": {
"description": "Optional optimistic-locking token from getWhiteboard. Only used for mode 'replace': if the board changed since you read it, the replace is rejected so you don't overwrite a collaborator's newer edits — re-read with getWhiteboard and retry. Not needed for patch/append, which automatically merge onto the latest scene.",
"type": "number"
}
},
"required": [
"documentId"
],
"type": "object"
},
"name": "updateWhiteboardScene",
"outputSchema": {
"type": "object"
}
},
{
"description": "Update a workspace's name. Auth: standard workspace-write ladder + user must be workspace owner or admin. Slug is intentionally not editable (URL-embedded). Rate limit 60/min.",
"inputSchema": {
"properties": {
"name": {
"maxLength": 200,
"minLength": 1,
"type": "string"
},
"workspace_id": {
"description": "Workspace UUID.",
"type": "string"
}
},
"required": [
"workspace_id",
"name"
],
"type": "object"
},
"name": "updateWorkspace",
"outputSchema": {
"properties": {
"href": {
"description": "Web URL of the resource in the Stable Baseline app.",
"type": "string"
},
"versionTimestamp": {
"description": "Milliseconds since epoch. Pass back as `versionTimestamp` on subsequent edit/update calls for optimistic locking.",
"type": "number"
},
"workspace": {
"description": "The workspace after the mutation.",
"type": "object"
}
},
"type": "object"
}
},
{
"description": "Change an existing workspace member's role. Caller must be a workspace owner or admin. Cannot self-demote from owner/admin to editor/viewer — transfer the role first.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"user_id": {
"type": "string"
},
"workspace_id": {
"type": "string"
},
"workspace_role": {
"enum": [
"owner",
"admin",
"editor",
"viewer"
],
"type": "string"
}
},
"required": [
"workspace_id",
"user_id",
"workspace_role"
],
"type": "object"
},
"name": "updateWorkspaceMember",
"outputSchema": {
"properties": {
"member": {
"type": "object"
}
},
"type": "object"
}
},
{
"description": "Insert or update a resource_permissions row for a user OR team on a workspace/project/folder/document/improvement/plan. Refuses self-escalation. Rate limit 30/min. Use when the user asks to give access to, share with, grant access, add a permission, make accessible, or invite someone to a specific workspace/project/folder/document — i.e. resource-level access (not org-level membership; that's inviteMember).",
"inputSchema": {
"additionalProperties": false,
"properties": {
"level": {
"enum": [
"none",
"read",
"write",
"admin"
],
"type": "string"
},
"principal_id": {
"description": "UUID of the user or team",
"type": "string"
},
"principal_type": {
"enum": [
"user",
"team"
],
"type": "string"
},
"resource_id": {
"description": "UUID of the resource",
"type": "string"
},
"resource_type": {
"enum": [
"workspace",
"project",
"folder",
"document",
"improvement",
"plan"
],
"type": "string"
}
},
"required": [
"resource_type",
"resource_id",
"principal_type",
"principal_id",
"level"
],
"type": "object"
},
"name": "upsertResourcePermission",
"outputSchema": {
"properties": {
"permission": {
"type": "object"
}
},
"type": "object"
}
}
]
}Verify it yourself
curl -s https://api.teppi.xyz/v1/evidence/sha256:fbaaccdfb2dd762f601c84b8297bf589309ecd1c3dc3c9418c4303cb33389112 | sha256sum