@stablebaseline/sdk 0.5.2 → 0.5.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -6
- package/dist/index.d.cts +19 -19
- package/dist/index.d.ts +19 -19
- package/openapi.json +135 -99
- package/package.json +2 -2
- package/src/types.generated.ts +19 -19
package/README.md
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
# @stablebaseline/sdk
|
|
2
2
|
|
|
3
3
|
[](https://www.npmjs.com/package/@stablebaseline/sdk)
|
|
4
|
-
[](https://stablebaseline.io/docs/mcp/tools)
|
|
5
5
|
|
|
6
|
-
TypeScript SDK for the **[Stable Baseline](https://stablebaseline.io) REST API** — the simplest, most complete, end-to-end agent-managed company brain. Living docs, 40+ visual diagrams, plans, and a self-learning Knowledge Graph.
|
|
6
|
+
TypeScript SDK for the **[Stable Baseline](https://stablebaseline.io) REST API** — the simplest, most complete, end-to-end agent-managed company brain. Living docs, 40+ visual diagrams, plans, and a self-learning Knowledge Graph. 196 tools across 18 categories.
|
|
7
7
|
|
|
8
8
|
## Install
|
|
9
9
|
|
|
@@ -16,7 +16,7 @@ npm install @stablebaseline/sdk
|
|
|
16
16
|
```ts
|
|
17
17
|
import { StableBaseline } from "@stablebaseline/sdk";
|
|
18
18
|
|
|
19
|
-
// Mint an API key at https://app.stablebaseline.io/settings/mcp-
|
|
19
|
+
// Mint an API key at https://app.stablebaseline.io/settings/mcp-setup
|
|
20
20
|
const sb = new StableBaseline({ apiKey: process.env.SB_API_KEY! });
|
|
21
21
|
|
|
22
22
|
const orgs = await sb.tools.listOrganisations({});
|
|
@@ -41,10 +41,10 @@ console.log(search.entities);
|
|
|
41
41
|
Two equivalent paths:
|
|
42
42
|
|
|
43
43
|
```ts
|
|
44
|
-
// API key (mint at app.stablebaseline.io/settings/mcp-
|
|
44
|
+
// API key (mint at app.stablebaseline.io/settings/mcp-setup, prefix sta_)
|
|
45
45
|
new StableBaseline({ apiKey: "sta_..." });
|
|
46
46
|
|
|
47
|
-
// OAuth 2.1 access token (interactive flow against api.stablebaseline.io/oauth/token)
|
|
47
|
+
// OAuth 2.1 access token (interactive flow against api.stablebaseline.io/functions/v1/cloud-serve/oauth/token)
|
|
48
48
|
new StableBaseline({ accessToken: "..." });
|
|
49
49
|
```
|
|
50
50
|
|
|
@@ -52,7 +52,7 @@ Both go in the `Authorization: Bearer <...>` header.
|
|
|
52
52
|
|
|
53
53
|
## Tool catalogue
|
|
54
54
|
|
|
55
|
-
|
|
55
|
+
196 tools across 18 categories. The full list lives at [stablebaseline.io/docs/mcp/tools](https://stablebaseline.io/docs/mcp/tools). Highlights:
|
|
56
56
|
|
|
57
57
|
| Category | Sample tools |
|
|
58
58
|
|---|---|
|
package/dist/index.d.cts
CHANGED
|
@@ -74,7 +74,7 @@ interface paths {
|
|
|
74
74
|
put?: never;
|
|
75
75
|
/**
|
|
76
76
|
* listArchitectureIcons
|
|
77
|
-
* @description SOFTWARE & CLOUD architecture icons ONLY (AWS, Azure, GCP, Docker, Kubernetes, databases, message queues, dev tools, etc.). This catalog has NO general/nature/science/people/business icons — so for any NON-technical topic (e.g. photosynthesis, biology, history, marketing), do NOT use this tool; instead put a relevant emoji directly in the element's label (
|
|
77
|
+
* @description SOFTWARE & CLOUD architecture icons ONLY (AWS, Azure, GCP, Docker, Kubernetes, databases, message queues, dev tools, etc.). This catalog has NO general/nature/science/people/business icons — so for any NON-technical topic (e.g. photosynthesis, biology, history, marketing), do NOT use this tool; instead put a relevant emoji directly in the element's label (for example a sun for sunlight, a droplet for water, a leaf for a plant). It returns nothing for off-domain queries by design — never force an unrelated tech logo onto a non-tech concept. Each result has an `iconPath` (e.g. 'dev/docker.svg'). TWO ways to use it: (1) on a WHITEBOARD, drop it via addWhiteboardElements({ type:'image', iconPath:'dev/docker.svg', x, y, width:96, height:96, text:'Docker' }); (2) in a D2 systems-architecture diagram, use the iconPath as-is in D2 code (e.g. icon: dev/docker.svg).
|
|
78
78
|
*/
|
|
79
79
|
post: operations["listArchitectureIcons"];
|
|
80
80
|
delete?: never;
|
|
@@ -914,7 +914,7 @@ interface paths {
|
|
|
914
914
|
put?: never;
|
|
915
915
|
/**
|
|
916
916
|
* addWhiteboardElements
|
|
917
|
-
* @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. 'Risks
|
|
917
|
+
* @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.
|
|
918
918
|
*/
|
|
919
919
|
post: operations["addWhiteboardElements"];
|
|
920
920
|
delete?: never;
|
|
@@ -1154,7 +1154,7 @@ interface paths {
|
|
|
1154
1154
|
put?: never;
|
|
1155
1155
|
/**
|
|
1156
1156
|
* reorderDocuments
|
|
1157
|
-
* @description MOVE documents between folders and/or reorder them — the batch filing tool. Pass [{documentId, position
|
|
1157
|
+
* @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).
|
|
1158
1158
|
*/
|
|
1159
1159
|
post: operations["reorderDocuments"];
|
|
1160
1160
|
delete?: never;
|
|
@@ -2262,7 +2262,7 @@ interface paths {
|
|
|
2262
2262
|
*
|
|
2263
2263
|
* PICK THE MODE THAT FITS THE QUERY:
|
|
2264
2264
|
*
|
|
2265
|
-
* • mode='local' (default) — for SPECIFIC factual questions ("what does
|
|
2265
|
+
* • 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.
|
|
2266
2266
|
*
|
|
2267
2267
|
* • 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.
|
|
2268
2268
|
*
|
|
@@ -2917,7 +2917,7 @@ interface paths {
|
|
|
2917
2917
|
put?: never;
|
|
2918
2918
|
/**
|
|
2919
2919
|
* createProject
|
|
2920
|
-
* @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
|
|
2920
|
+
* @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.
|
|
2921
2921
|
*/
|
|
2922
2922
|
post: operations["createProject"];
|
|
2923
2923
|
delete?: never;
|
|
@@ -3984,10 +3984,10 @@ interface operations {
|
|
|
3984
3984
|
/** @description Natural language description of what you want to do. */
|
|
3985
3985
|
query?: string;
|
|
3986
3986
|
/**
|
|
3987
|
-
* @description Category filter.
|
|
3987
|
+
* @description Category filter. One of the 18 categories returned in each result's `category` field.
|
|
3988
3988
|
* @enum {string}
|
|
3989
3989
|
*/
|
|
3990
|
-
category?: "navigation" | "folders" | "documents" | "diagrams" | "images" | "data" | "improvements" | "plans" | "knowledge_graph" | "organization" | "members" | "teams" | "permissions" | "billing" | "kg_admin" | "settings" | "signup";
|
|
3990
|
+
category?: "navigation" | "folders" | "documents" | "diagrams" | "images" | "whiteboards" | "data" | "improvements" | "plans" | "knowledge_graph" | "organization" | "members" | "teams" | "permissions" | "billing" | "kg_admin" | "settings" | "signup";
|
|
3991
3991
|
};
|
|
3992
3992
|
};
|
|
3993
3993
|
};
|
|
@@ -9410,10 +9410,10 @@ interface operations {
|
|
|
9410
9410
|
/** @description Documents to file. All must belong to the same project (a batch spanning projects is rejected). */
|
|
9411
9411
|
items: {
|
|
9412
9412
|
documentId: string;
|
|
9413
|
-
/** @description
|
|
9414
|
-
position: number;
|
|
9415
|
-
/** @description Optional. 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. */
|
|
9413
|
+
/** @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. */
|
|
9416
9414
|
folderId?: string | null;
|
|
9415
|
+
/** @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…. */
|
|
9416
|
+
position?: number;
|
|
9417
9417
|
}[];
|
|
9418
9418
|
};
|
|
9419
9419
|
};
|
|
@@ -10722,7 +10722,7 @@ interface operations {
|
|
|
10722
10722
|
user_impact?: string;
|
|
10723
10723
|
why_now?: string;
|
|
10724
10724
|
/** @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 }`. */
|
|
10725
|
-
acceptance_criteria?: {
|
|
10725
|
+
acceptance_criteria?: (string | {
|
|
10726
10726
|
/** @description Optional — server mints one if omitted. Preserve on edits. */
|
|
10727
10727
|
id?: string;
|
|
10728
10728
|
text: string;
|
|
@@ -10732,7 +10732,7 @@ interface operations {
|
|
|
10732
10732
|
updated_by?: string;
|
|
10733
10733
|
/** @description Server-stamped credential label. Echo back unchanged. */
|
|
10734
10734
|
updated_by_credential_name?: string;
|
|
10735
|
-
}[];
|
|
10735
|
+
})[];
|
|
10736
10736
|
/** @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. */
|
|
10737
10737
|
checklist?: {
|
|
10738
10738
|
/** @description Optional — server mints one if omitted. Preserve on edits. */
|
|
@@ -10908,7 +10908,7 @@ interface operations {
|
|
|
10908
10908
|
user_impact?: string;
|
|
10909
10909
|
why_now?: string;
|
|
10910
10910
|
/** @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 }`. */
|
|
10911
|
-
acceptance_criteria?: {
|
|
10911
|
+
acceptance_criteria?: (string | {
|
|
10912
10912
|
/** @description Optional — server mints one if omitted. Preserve on edits. */
|
|
10913
10913
|
id?: string;
|
|
10914
10914
|
text: string;
|
|
@@ -10918,7 +10918,7 @@ interface operations {
|
|
|
10918
10918
|
updated_by?: string;
|
|
10919
10919
|
/** @description Server-stamped credential label. Echo back unchanged. */
|
|
10920
10920
|
updated_by_credential_name?: string;
|
|
10921
|
-
}[];
|
|
10921
|
+
})[];
|
|
10922
10922
|
/** @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. */
|
|
10923
10923
|
checklist?: {
|
|
10924
10924
|
/** @description Optional — server mints one if omitted. Preserve on edits. */
|
|
@@ -13337,7 +13337,7 @@ interface operations {
|
|
|
13337
13337
|
user_impact?: string;
|
|
13338
13338
|
why_now?: string;
|
|
13339
13339
|
/** @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 }`. */
|
|
13340
|
-
acceptance_criteria?: {
|
|
13340
|
+
acceptance_criteria?: (string | {
|
|
13341
13341
|
/** @description Optional — server mints one if omitted. Preserve on edits. */
|
|
13342
13342
|
id?: string;
|
|
13343
13343
|
text: string;
|
|
@@ -13347,7 +13347,7 @@ interface operations {
|
|
|
13347
13347
|
updated_by?: string;
|
|
13348
13348
|
/** @description Server-stamped credential label. Echo back unchanged. */
|
|
13349
13349
|
updated_by_credential_name?: string;
|
|
13350
|
-
}[];
|
|
13350
|
+
})[];
|
|
13351
13351
|
/** @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. */
|
|
13352
13352
|
checklist?: {
|
|
13353
13353
|
/** @description Optional — server mints one if omitted. Preserve on edits. */
|
|
@@ -13705,7 +13705,7 @@ interface operations {
|
|
|
13705
13705
|
user_impact?: string;
|
|
13706
13706
|
why_now?: string;
|
|
13707
13707
|
/** @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 }`. */
|
|
13708
|
-
acceptance_criteria?: {
|
|
13708
|
+
acceptance_criteria?: (string | {
|
|
13709
13709
|
/** @description Optional — server mints one if omitted. Preserve on edits. */
|
|
13710
13710
|
id?: string;
|
|
13711
13711
|
text: string;
|
|
@@ -13715,7 +13715,7 @@ interface operations {
|
|
|
13715
13715
|
updated_by?: string;
|
|
13716
13716
|
/** @description Server-stamped credential label. Echo back unchanged. */
|
|
13717
13717
|
updated_by_credential_name?: string;
|
|
13718
|
-
}[];
|
|
13718
|
+
})[];
|
|
13719
13719
|
/** @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. */
|
|
13720
13720
|
checklist?: {
|
|
13721
13721
|
/** @description Optional — server mints one if omitted. Preserve on edits. */
|
|
@@ -17443,7 +17443,7 @@ interface operations {
|
|
|
17443
17443
|
name: string;
|
|
17444
17444
|
/** @description Optional description. */
|
|
17445
17445
|
description?: string;
|
|
17446
|
-
/** @description Optional emoji icon. Defaults to
|
|
17446
|
+
/** @description Optional emoji icon. Defaults to a folder emoji to match the UI. */
|
|
17447
17447
|
icon?: string;
|
|
17448
17448
|
};
|
|
17449
17449
|
};
|
package/dist/index.d.ts
CHANGED
|
@@ -74,7 +74,7 @@ interface paths {
|
|
|
74
74
|
put?: never;
|
|
75
75
|
/**
|
|
76
76
|
* listArchitectureIcons
|
|
77
|
-
* @description SOFTWARE & CLOUD architecture icons ONLY (AWS, Azure, GCP, Docker, Kubernetes, databases, message queues, dev tools, etc.). This catalog has NO general/nature/science/people/business icons — so for any NON-technical topic (e.g. photosynthesis, biology, history, marketing), do NOT use this tool; instead put a relevant emoji directly in the element's label (
|
|
77
|
+
* @description SOFTWARE & CLOUD architecture icons ONLY (AWS, Azure, GCP, Docker, Kubernetes, databases, message queues, dev tools, etc.). This catalog has NO general/nature/science/people/business icons — so for any NON-technical topic (e.g. photosynthesis, biology, history, marketing), do NOT use this tool; instead put a relevant emoji directly in the element's label (for example a sun for sunlight, a droplet for water, a leaf for a plant). It returns nothing for off-domain queries by design — never force an unrelated tech logo onto a non-tech concept. Each result has an `iconPath` (e.g. 'dev/docker.svg'). TWO ways to use it: (1) on a WHITEBOARD, drop it via addWhiteboardElements({ type:'image', iconPath:'dev/docker.svg', x, y, width:96, height:96, text:'Docker' }); (2) in a D2 systems-architecture diagram, use the iconPath as-is in D2 code (e.g. icon: dev/docker.svg).
|
|
78
78
|
*/
|
|
79
79
|
post: operations["listArchitectureIcons"];
|
|
80
80
|
delete?: never;
|
|
@@ -914,7 +914,7 @@ interface paths {
|
|
|
914
914
|
put?: never;
|
|
915
915
|
/**
|
|
916
916
|
* addWhiteboardElements
|
|
917
|
-
* @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. 'Risks
|
|
917
|
+
* @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.
|
|
918
918
|
*/
|
|
919
919
|
post: operations["addWhiteboardElements"];
|
|
920
920
|
delete?: never;
|
|
@@ -1154,7 +1154,7 @@ interface paths {
|
|
|
1154
1154
|
put?: never;
|
|
1155
1155
|
/**
|
|
1156
1156
|
* reorderDocuments
|
|
1157
|
-
* @description MOVE documents between folders and/or reorder them — the batch filing tool. Pass [{documentId, position
|
|
1157
|
+
* @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).
|
|
1158
1158
|
*/
|
|
1159
1159
|
post: operations["reorderDocuments"];
|
|
1160
1160
|
delete?: never;
|
|
@@ -2262,7 +2262,7 @@ interface paths {
|
|
|
2262
2262
|
*
|
|
2263
2263
|
* PICK THE MODE THAT FITS THE QUERY:
|
|
2264
2264
|
*
|
|
2265
|
-
* • mode='local' (default) — for SPECIFIC factual questions ("what does
|
|
2265
|
+
* • 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.
|
|
2266
2266
|
*
|
|
2267
2267
|
* • 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.
|
|
2268
2268
|
*
|
|
@@ -2917,7 +2917,7 @@ interface paths {
|
|
|
2917
2917
|
put?: never;
|
|
2918
2918
|
/**
|
|
2919
2919
|
* createProject
|
|
2920
|
-
* @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
|
|
2920
|
+
* @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.
|
|
2921
2921
|
*/
|
|
2922
2922
|
post: operations["createProject"];
|
|
2923
2923
|
delete?: never;
|
|
@@ -3984,10 +3984,10 @@ interface operations {
|
|
|
3984
3984
|
/** @description Natural language description of what you want to do. */
|
|
3985
3985
|
query?: string;
|
|
3986
3986
|
/**
|
|
3987
|
-
* @description Category filter.
|
|
3987
|
+
* @description Category filter. One of the 18 categories returned in each result's `category` field.
|
|
3988
3988
|
* @enum {string}
|
|
3989
3989
|
*/
|
|
3990
|
-
category?: "navigation" | "folders" | "documents" | "diagrams" | "images" | "data" | "improvements" | "plans" | "knowledge_graph" | "organization" | "members" | "teams" | "permissions" | "billing" | "kg_admin" | "settings" | "signup";
|
|
3990
|
+
category?: "navigation" | "folders" | "documents" | "diagrams" | "images" | "whiteboards" | "data" | "improvements" | "plans" | "knowledge_graph" | "organization" | "members" | "teams" | "permissions" | "billing" | "kg_admin" | "settings" | "signup";
|
|
3991
3991
|
};
|
|
3992
3992
|
};
|
|
3993
3993
|
};
|
|
@@ -9410,10 +9410,10 @@ interface operations {
|
|
|
9410
9410
|
/** @description Documents to file. All must belong to the same project (a batch spanning projects is rejected). */
|
|
9411
9411
|
items: {
|
|
9412
9412
|
documentId: string;
|
|
9413
|
-
/** @description
|
|
9414
|
-
position: number;
|
|
9415
|
-
/** @description Optional. 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. */
|
|
9413
|
+
/** @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. */
|
|
9416
9414
|
folderId?: string | null;
|
|
9415
|
+
/** @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…. */
|
|
9416
|
+
position?: number;
|
|
9417
9417
|
}[];
|
|
9418
9418
|
};
|
|
9419
9419
|
};
|
|
@@ -10722,7 +10722,7 @@ interface operations {
|
|
|
10722
10722
|
user_impact?: string;
|
|
10723
10723
|
why_now?: string;
|
|
10724
10724
|
/** @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 }`. */
|
|
10725
|
-
acceptance_criteria?: {
|
|
10725
|
+
acceptance_criteria?: (string | {
|
|
10726
10726
|
/** @description Optional — server mints one if omitted. Preserve on edits. */
|
|
10727
10727
|
id?: string;
|
|
10728
10728
|
text: string;
|
|
@@ -10732,7 +10732,7 @@ interface operations {
|
|
|
10732
10732
|
updated_by?: string;
|
|
10733
10733
|
/** @description Server-stamped credential label. Echo back unchanged. */
|
|
10734
10734
|
updated_by_credential_name?: string;
|
|
10735
|
-
}[];
|
|
10735
|
+
})[];
|
|
10736
10736
|
/** @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. */
|
|
10737
10737
|
checklist?: {
|
|
10738
10738
|
/** @description Optional — server mints one if omitted. Preserve on edits. */
|
|
@@ -10908,7 +10908,7 @@ interface operations {
|
|
|
10908
10908
|
user_impact?: string;
|
|
10909
10909
|
why_now?: string;
|
|
10910
10910
|
/** @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 }`. */
|
|
10911
|
-
acceptance_criteria?: {
|
|
10911
|
+
acceptance_criteria?: (string | {
|
|
10912
10912
|
/** @description Optional — server mints one if omitted. Preserve on edits. */
|
|
10913
10913
|
id?: string;
|
|
10914
10914
|
text: string;
|
|
@@ -10918,7 +10918,7 @@ interface operations {
|
|
|
10918
10918
|
updated_by?: string;
|
|
10919
10919
|
/** @description Server-stamped credential label. Echo back unchanged. */
|
|
10920
10920
|
updated_by_credential_name?: string;
|
|
10921
|
-
}[];
|
|
10921
|
+
})[];
|
|
10922
10922
|
/** @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. */
|
|
10923
10923
|
checklist?: {
|
|
10924
10924
|
/** @description Optional — server mints one if omitted. Preserve on edits. */
|
|
@@ -13337,7 +13337,7 @@ interface operations {
|
|
|
13337
13337
|
user_impact?: string;
|
|
13338
13338
|
why_now?: string;
|
|
13339
13339
|
/** @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 }`. */
|
|
13340
|
-
acceptance_criteria?: {
|
|
13340
|
+
acceptance_criteria?: (string | {
|
|
13341
13341
|
/** @description Optional — server mints one if omitted. Preserve on edits. */
|
|
13342
13342
|
id?: string;
|
|
13343
13343
|
text: string;
|
|
@@ -13347,7 +13347,7 @@ interface operations {
|
|
|
13347
13347
|
updated_by?: string;
|
|
13348
13348
|
/** @description Server-stamped credential label. Echo back unchanged. */
|
|
13349
13349
|
updated_by_credential_name?: string;
|
|
13350
|
-
}[];
|
|
13350
|
+
})[];
|
|
13351
13351
|
/** @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. */
|
|
13352
13352
|
checklist?: {
|
|
13353
13353
|
/** @description Optional — server mints one if omitted. Preserve on edits. */
|
|
@@ -13705,7 +13705,7 @@ interface operations {
|
|
|
13705
13705
|
user_impact?: string;
|
|
13706
13706
|
why_now?: string;
|
|
13707
13707
|
/** @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 }`. */
|
|
13708
|
-
acceptance_criteria?: {
|
|
13708
|
+
acceptance_criteria?: (string | {
|
|
13709
13709
|
/** @description Optional — server mints one if omitted. Preserve on edits. */
|
|
13710
13710
|
id?: string;
|
|
13711
13711
|
text: string;
|
|
@@ -13715,7 +13715,7 @@ interface operations {
|
|
|
13715
13715
|
updated_by?: string;
|
|
13716
13716
|
/** @description Server-stamped credential label. Echo back unchanged. */
|
|
13717
13717
|
updated_by_credential_name?: string;
|
|
13718
|
-
}[];
|
|
13718
|
+
})[];
|
|
13719
13719
|
/** @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. */
|
|
13720
13720
|
checklist?: {
|
|
13721
13721
|
/** @description Optional — server mints one if omitted. Preserve on edits. */
|
|
@@ -17443,7 +17443,7 @@ interface operations {
|
|
|
17443
17443
|
name: string;
|
|
17444
17444
|
/** @description Optional description. */
|
|
17445
17445
|
description?: string;
|
|
17446
|
-
/** @description Optional emoji icon. Defaults to
|
|
17446
|
+
/** @description Optional emoji icon. Defaults to a folder emoji to match the UI. */
|
|
17447
17447
|
icon?: string;
|
|
17448
17448
|
};
|
|
17449
17449
|
};
|
package/openapi.json
CHANGED
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
"bearerAuth": {
|
|
30
30
|
"type": "http",
|
|
31
31
|
"scheme": "bearer",
|
|
32
|
-
"description": "Either an MCP API key (prefix `sta_`, mint at https://app.stablebaseline.io/settings/mcp-
|
|
32
|
+
"description": "Either an MCP API key (prefix `sta_`, mint at https://app.stablebaseline.io/settings/mcp-setup) or an OAuth 2.1 access token. Every OAuth endpoint lives under this function, and the authoritative list is at https://api.stablebaseline.io/functions/v1/cloud-serve/.well-known/oauth-authorization-server: authorize at https://api.stablebaseline.io/functions/v1/cloud-serve/oauth/authorize, exchange at https://api.stablebaseline.io/functions/v1/cloud-serve/oauth/token."
|
|
33
33
|
}
|
|
34
34
|
},
|
|
35
35
|
"schemas": {
|
|
@@ -161,13 +161,14 @@
|
|
|
161
161
|
},
|
|
162
162
|
"category": {
|
|
163
163
|
"type": "string",
|
|
164
|
-
"description": "Category filter.",
|
|
164
|
+
"description": "Category filter. One of the 18 categories returned in each result's `category` field.",
|
|
165
165
|
"enum": [
|
|
166
166
|
"navigation",
|
|
167
167
|
"folders",
|
|
168
168
|
"documents",
|
|
169
169
|
"diagrams",
|
|
170
170
|
"images",
|
|
171
|
+
"whiteboards",
|
|
171
172
|
"data",
|
|
172
173
|
"improvements",
|
|
173
174
|
"plans",
|
|
@@ -488,7 +489,7 @@
|
|
|
488
489
|
"/tools/listArchitectureIcons": {
|
|
489
490
|
"post": {
|
|
490
491
|
"summary": "listArchitectureIcons",
|
|
491
|
-
"description": "SOFTWARE & CLOUD architecture icons ONLY (AWS, Azure, GCP, Docker, Kubernetes, databases, message queues, dev tools, etc.). This catalog has NO general/nature/science/people/business icons — so for any NON-technical topic (e.g. photosynthesis, biology, history, marketing), do NOT use this tool; instead put a relevant emoji directly in the element's label (
|
|
492
|
+
"description": "SOFTWARE & CLOUD architecture icons ONLY (AWS, Azure, GCP, Docker, Kubernetes, databases, message queues, dev tools, etc.). This catalog has NO general/nature/science/people/business icons — so for any NON-technical topic (e.g. photosynthesis, biology, history, marketing), do NOT use this tool; instead put a relevant emoji directly in the element's label (for example a sun for sunlight, a droplet for water, a leaf for a plant). It returns nothing for off-domain queries by design — never force an unrelated tech logo onto a non-tech concept. Each result has an `iconPath` (e.g. 'dev/docker.svg'). TWO ways to use it: (1) on a WHITEBOARD, drop it via addWhiteboardElements({ type:'image', iconPath:'dev/docker.svg', x, y, width:96, height:96, text:'Docker' }); (2) in a D2 systems-architecture diagram, use the iconPath as-is in D2 code (e.g. icon: dev/docker.svg).",
|
|
492
493
|
"operationId": "listArchitectureIcons",
|
|
493
494
|
"tags": [
|
|
494
495
|
"diagrams"
|
|
@@ -4260,6 +4261,7 @@
|
|
|
4260
4261
|
},
|
|
4261
4262
|
"maskBase64": {
|
|
4262
4263
|
"type": "string",
|
|
4264
|
+
"contentEncoding": "base64",
|
|
4263
4265
|
"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."
|
|
4264
4266
|
},
|
|
4265
4267
|
"prompt": {
|
|
@@ -5749,7 +5751,7 @@
|
|
|
5749
5751
|
"/tools/addWhiteboardElements": {
|
|
5750
5752
|
"post": {
|
|
5751
5753
|
"summary": "addWhiteboardElements",
|
|
5752
|
-
"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. 'Risks
|
|
5754
|
+
"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.",
|
|
5753
5755
|
"operationId": "addWhiteboardElements",
|
|
5754
5756
|
"tags": [
|
|
5755
5757
|
"whiteboards"
|
|
@@ -6218,6 +6220,7 @@
|
|
|
6218
6220
|
},
|
|
6219
6221
|
"imageBase64": {
|
|
6220
6222
|
"type": "string",
|
|
6223
|
+
"contentEncoding": "base64",
|
|
6221
6224
|
"description": "Base64-encoded image bytes (a data: URL prefix is allowed). Best for small images."
|
|
6222
6225
|
},
|
|
6223
6226
|
"imageBinary": {
|
|
@@ -6533,6 +6536,7 @@
|
|
|
6533
6536
|
},
|
|
6534
6537
|
"imageBase64": {
|
|
6535
6538
|
"type": "string",
|
|
6539
|
+
"contentEncoding": "base64",
|
|
6536
6540
|
"description": "Base64-encoded image bytes (a data: URL prefix is allowed). Use instead of imageUrl."
|
|
6537
6541
|
},
|
|
6538
6542
|
"mimeType": {
|
|
@@ -7533,7 +7537,7 @@
|
|
|
7533
7537
|
"/tools/reorderDocuments": {
|
|
7534
7538
|
"post": {
|
|
7535
7539
|
"summary": "reorderDocuments",
|
|
7536
|
-
"description": "MOVE documents between folders and/or reorder them — the batch filing tool. Pass [{documentId, position
|
|
7540
|
+
"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).",
|
|
7537
7541
|
"operationId": "reorderDocuments",
|
|
7538
7542
|
"tags": [
|
|
7539
7543
|
"documents"
|
|
@@ -7554,21 +7558,20 @@
|
|
|
7554
7558
|
"documentId": {
|
|
7555
7559
|
"type": "string"
|
|
7556
7560
|
},
|
|
7557
|
-
"position": {
|
|
7558
|
-
"type": "number",
|
|
7559
|
-
"description": "Sort position among siblings. Non-negative integer."
|
|
7560
|
-
},
|
|
7561
7561
|
"folderId": {
|
|
7562
7562
|
"type": [
|
|
7563
7563
|
"string",
|
|
7564
7564
|
"null"
|
|
7565
7565
|
],
|
|
7566
|
-
"description": "
|
|
7566
|
+
"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."
|
|
7567
|
+
},
|
|
7568
|
+
"position": {
|
|
7569
|
+
"type": "number",
|
|
7570
|
+
"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…."
|
|
7567
7571
|
}
|
|
7568
7572
|
},
|
|
7569
7573
|
"required": [
|
|
7570
|
-
"documentId"
|
|
7571
|
-
"position"
|
|
7574
|
+
"documentId"
|
|
7572
7575
|
]
|
|
7573
7576
|
},
|
|
7574
7577
|
"minItems": 1
|
|
@@ -8046,6 +8049,7 @@
|
|
|
8046
8049
|
},
|
|
8047
8050
|
"imageBase64": {
|
|
8048
8051
|
"type": "string",
|
|
8052
|
+
"contentEncoding": "base64",
|
|
8049
8053
|
"description": "Base64-encoded image data. Mutually exclusive with imageBinary/imageUrl."
|
|
8050
8054
|
},
|
|
8051
8055
|
"imageBinary": {
|
|
@@ -9324,30 +9328,38 @@
|
|
|
9324
9328
|
"type": "array",
|
|
9325
9329
|
"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 }`.",
|
|
9326
9330
|
"items": {
|
|
9327
|
-
"
|
|
9328
|
-
|
|
9329
|
-
"id": {
|
|
9330
|
-
"type": "string",
|
|
9331
|
-
"description": "Optional — server mints one if omitted. Preserve on edits."
|
|
9332
|
-
},
|
|
9333
|
-
"text": {
|
|
9334
|
-
"type": "string"
|
|
9335
|
-
},
|
|
9336
|
-
"updated_at": {
|
|
9337
|
-
"type": "string",
|
|
9338
|
-
"description": "Server-stamped. Echo back unchanged; ignored on new rows."
|
|
9339
|
-
},
|
|
9340
|
-
"updated_by": {
|
|
9331
|
+
"anyOf": [
|
|
9332
|
+
{
|
|
9341
9333
|
"type": "string",
|
|
9342
|
-
"description": "
|
|
9334
|
+
"description": "Shorthand for `{ text: \"...\" }`."
|
|
9343
9335
|
},
|
|
9344
|
-
|
|
9345
|
-
"type": "
|
|
9346
|
-
"
|
|
9336
|
+
{
|
|
9337
|
+
"type": "object",
|
|
9338
|
+
"properties": {
|
|
9339
|
+
"id": {
|
|
9340
|
+
"type": "string",
|
|
9341
|
+
"description": "Optional — server mints one if omitted. Preserve on edits."
|
|
9342
|
+
},
|
|
9343
|
+
"text": {
|
|
9344
|
+
"type": "string"
|
|
9345
|
+
},
|
|
9346
|
+
"updated_at": {
|
|
9347
|
+
"type": "string",
|
|
9348
|
+
"description": "Server-stamped. Echo back unchanged; ignored on new rows."
|
|
9349
|
+
},
|
|
9350
|
+
"updated_by": {
|
|
9351
|
+
"type": "string",
|
|
9352
|
+
"description": "Server-stamped user id. Echo back unchanged."
|
|
9353
|
+
},
|
|
9354
|
+
"updated_by_credential_name": {
|
|
9355
|
+
"type": "string",
|
|
9356
|
+
"description": "Server-stamped credential label. Echo back unchanged."
|
|
9357
|
+
}
|
|
9358
|
+
},
|
|
9359
|
+
"required": [
|
|
9360
|
+
"text"
|
|
9361
|
+
]
|
|
9347
9362
|
}
|
|
9348
|
-
},
|
|
9349
|
-
"required": [
|
|
9350
|
-
"text"
|
|
9351
9363
|
]
|
|
9352
9364
|
}
|
|
9353
9365
|
},
|
|
@@ -9700,30 +9712,38 @@
|
|
|
9700
9712
|
"type": "array",
|
|
9701
9713
|
"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 }`.",
|
|
9702
9714
|
"items": {
|
|
9703
|
-
"
|
|
9704
|
-
|
|
9705
|
-
"id": {
|
|
9706
|
-
"type": "string",
|
|
9707
|
-
"description": "Optional — server mints one if omitted. Preserve on edits."
|
|
9708
|
-
},
|
|
9709
|
-
"text": {
|
|
9710
|
-
"type": "string"
|
|
9711
|
-
},
|
|
9712
|
-
"updated_at": {
|
|
9715
|
+
"anyOf": [
|
|
9716
|
+
{
|
|
9713
9717
|
"type": "string",
|
|
9714
|
-
"description": "
|
|
9718
|
+
"description": "Shorthand for `{ text: \"...\" }`."
|
|
9715
9719
|
},
|
|
9716
|
-
|
|
9717
|
-
"type": "
|
|
9718
|
-
"
|
|
9719
|
-
|
|
9720
|
-
|
|
9721
|
-
|
|
9722
|
-
|
|
9720
|
+
{
|
|
9721
|
+
"type": "object",
|
|
9722
|
+
"properties": {
|
|
9723
|
+
"id": {
|
|
9724
|
+
"type": "string",
|
|
9725
|
+
"description": "Optional — server mints one if omitted. Preserve on edits."
|
|
9726
|
+
},
|
|
9727
|
+
"text": {
|
|
9728
|
+
"type": "string"
|
|
9729
|
+
},
|
|
9730
|
+
"updated_at": {
|
|
9731
|
+
"type": "string",
|
|
9732
|
+
"description": "Server-stamped. Echo back unchanged; ignored on new rows."
|
|
9733
|
+
},
|
|
9734
|
+
"updated_by": {
|
|
9735
|
+
"type": "string",
|
|
9736
|
+
"description": "Server-stamped user id. Echo back unchanged."
|
|
9737
|
+
},
|
|
9738
|
+
"updated_by_credential_name": {
|
|
9739
|
+
"type": "string",
|
|
9740
|
+
"description": "Server-stamped credential label. Echo back unchanged."
|
|
9741
|
+
}
|
|
9742
|
+
},
|
|
9743
|
+
"required": [
|
|
9744
|
+
"text"
|
|
9745
|
+
]
|
|
9723
9746
|
}
|
|
9724
|
-
},
|
|
9725
|
-
"required": [
|
|
9726
|
-
"text"
|
|
9727
9747
|
]
|
|
9728
9748
|
}
|
|
9729
9749
|
},
|
|
@@ -13066,30 +13086,38 @@
|
|
|
13066
13086
|
"type": "array",
|
|
13067
13087
|
"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 }`.",
|
|
13068
13088
|
"items": {
|
|
13069
|
-
"
|
|
13070
|
-
|
|
13071
|
-
"id": {
|
|
13072
|
-
"type": "string",
|
|
13073
|
-
"description": "Optional — server mints one if omitted. Preserve on edits."
|
|
13074
|
-
},
|
|
13075
|
-
"text": {
|
|
13076
|
-
"type": "string"
|
|
13077
|
-
},
|
|
13078
|
-
"updated_at": {
|
|
13079
|
-
"type": "string",
|
|
13080
|
-
"description": "Server-stamped. Echo back unchanged; ignored on new rows."
|
|
13081
|
-
},
|
|
13082
|
-
"updated_by": {
|
|
13089
|
+
"anyOf": [
|
|
13090
|
+
{
|
|
13083
13091
|
"type": "string",
|
|
13084
|
-
"description": "
|
|
13092
|
+
"description": "Shorthand for `{ text: \"...\" }`."
|
|
13085
13093
|
},
|
|
13086
|
-
|
|
13087
|
-
"type": "
|
|
13088
|
-
"
|
|
13094
|
+
{
|
|
13095
|
+
"type": "object",
|
|
13096
|
+
"properties": {
|
|
13097
|
+
"id": {
|
|
13098
|
+
"type": "string",
|
|
13099
|
+
"description": "Optional — server mints one if omitted. Preserve on edits."
|
|
13100
|
+
},
|
|
13101
|
+
"text": {
|
|
13102
|
+
"type": "string"
|
|
13103
|
+
},
|
|
13104
|
+
"updated_at": {
|
|
13105
|
+
"type": "string",
|
|
13106
|
+
"description": "Server-stamped. Echo back unchanged; ignored on new rows."
|
|
13107
|
+
},
|
|
13108
|
+
"updated_by": {
|
|
13109
|
+
"type": "string",
|
|
13110
|
+
"description": "Server-stamped user id. Echo back unchanged."
|
|
13111
|
+
},
|
|
13112
|
+
"updated_by_credential_name": {
|
|
13113
|
+
"type": "string",
|
|
13114
|
+
"description": "Server-stamped credential label. Echo back unchanged."
|
|
13115
|
+
}
|
|
13116
|
+
},
|
|
13117
|
+
"required": [
|
|
13118
|
+
"text"
|
|
13119
|
+
]
|
|
13089
13120
|
}
|
|
13090
|
-
},
|
|
13091
|
-
"required": [
|
|
13092
|
-
"text"
|
|
13093
13121
|
]
|
|
13094
13122
|
}
|
|
13095
13123
|
},
|
|
@@ -13680,30 +13708,38 @@
|
|
|
13680
13708
|
"type": "array",
|
|
13681
13709
|
"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 }`.",
|
|
13682
13710
|
"items": {
|
|
13683
|
-
"
|
|
13684
|
-
|
|
13685
|
-
"id": {
|
|
13686
|
-
"type": "string",
|
|
13687
|
-
"description": "Optional — server mints one if omitted. Preserve on edits."
|
|
13688
|
-
},
|
|
13689
|
-
"text": {
|
|
13690
|
-
"type": "string"
|
|
13691
|
-
},
|
|
13692
|
-
"updated_at": {
|
|
13693
|
-
"type": "string",
|
|
13694
|
-
"description": "Server-stamped. Echo back unchanged; ignored on new rows."
|
|
13695
|
-
},
|
|
13696
|
-
"updated_by": {
|
|
13711
|
+
"anyOf": [
|
|
13712
|
+
{
|
|
13697
13713
|
"type": "string",
|
|
13698
|
-
"description": "
|
|
13714
|
+
"description": "Shorthand for `{ text: \"...\" }`."
|
|
13699
13715
|
},
|
|
13700
|
-
|
|
13701
|
-
"type": "
|
|
13702
|
-
"
|
|
13716
|
+
{
|
|
13717
|
+
"type": "object",
|
|
13718
|
+
"properties": {
|
|
13719
|
+
"id": {
|
|
13720
|
+
"type": "string",
|
|
13721
|
+
"description": "Optional — server mints one if omitted. Preserve on edits."
|
|
13722
|
+
},
|
|
13723
|
+
"text": {
|
|
13724
|
+
"type": "string"
|
|
13725
|
+
},
|
|
13726
|
+
"updated_at": {
|
|
13727
|
+
"type": "string",
|
|
13728
|
+
"description": "Server-stamped. Echo back unchanged; ignored on new rows."
|
|
13729
|
+
},
|
|
13730
|
+
"updated_by": {
|
|
13731
|
+
"type": "string",
|
|
13732
|
+
"description": "Server-stamped user id. Echo back unchanged."
|
|
13733
|
+
},
|
|
13734
|
+
"updated_by_credential_name": {
|
|
13735
|
+
"type": "string",
|
|
13736
|
+
"description": "Server-stamped credential label. Echo back unchanged."
|
|
13737
|
+
}
|
|
13738
|
+
},
|
|
13739
|
+
"required": [
|
|
13740
|
+
"text"
|
|
13741
|
+
]
|
|
13703
13742
|
}
|
|
13704
|
-
},
|
|
13705
|
-
"required": [
|
|
13706
|
-
"text"
|
|
13707
13743
|
]
|
|
13708
13744
|
}
|
|
13709
13745
|
},
|
|
@@ -15047,7 +15083,7 @@
|
|
|
15047
15083
|
"/tools/kg_search": {
|
|
15048
15084
|
"post": {
|
|
15049
15085
|
"summary": "kg_search",
|
|
15050
|
-
"description": "Unified Knowledge Graph KNOWLEDGE retrieval — facts, themes and relationships from INSIDE document CONTENT. This is NOT an artefact finder: do NOT use it to locate a document / whiteboard / diagram / plan / task / improvement by its TITLE or friendly id (e.g. \"DOC-123\", \"find the GTM plan\"). For locating an artefact by name or id use listDocuments / listWhiteboards / listPlans / listTasks / searchImprovements (they match title + friendly id). Use kg_search only to ANSWER A QUESTION from the knowledge contained in the artefacts.\n\nPICK THE MODE THAT FITS THE QUERY:\n\n• mode='local' (default) — for SPECIFIC factual questions (\"what does
|
|
15086
|
+
"description": "Unified Knowledge Graph KNOWLEDGE retrieval — facts, themes and relationships from INSIDE document CONTENT. This is NOT an artefact finder: do NOT use it to locate a document / whiteboard / diagram / plan / task / improvement by its TITLE or friendly id (e.g. \"DOC-123\", \"find the GTM plan\"). For locating an artefact by name or id use listDocuments / listWhiteboards / listPlans / listTasks / searchImprovements (they match title + friendly id). Use kg_search only to ANSWER A QUESTION from the knowledge contained in the artefacts.\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'",
|
|
15051
15087
|
"operationId": "kg_search",
|
|
15052
15088
|
"tags": [
|
|
15053
15089
|
"knowledge_graph"
|
|
@@ -18483,7 +18519,7 @@
|
|
|
18483
18519
|
"/tools/createProject": {
|
|
18484
18520
|
"post": {
|
|
18485
18521
|
"summary": "createProject",
|
|
18486
|
-
"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
|
|
18522
|
+
"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.",
|
|
18487
18523
|
"operationId": "createProject",
|
|
18488
18524
|
"tags": [
|
|
18489
18525
|
"organization"
|
|
@@ -18513,7 +18549,7 @@
|
|
|
18513
18549
|
"icon": {
|
|
18514
18550
|
"type": "string",
|
|
18515
18551
|
"maxLength": 32,
|
|
18516
|
-
"description": "Optional emoji icon. Defaults to
|
|
18552
|
+
"description": "Optional emoji icon. Defaults to a folder emoji to match the UI."
|
|
18517
18553
|
}
|
|
18518
18554
|
},
|
|
18519
18555
|
"required": [
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@stablebaseline/sdk",
|
|
3
|
-
"version": "0.5.
|
|
4
|
-
"description": "TypeScript SDK for the Stable Baseline REST API. End-to-end agent-managed company brain — docs, diagrams, plans, and a self-learning Knowledge Graph.
|
|
3
|
+
"version": "0.5.3",
|
|
4
|
+
"description": "TypeScript SDK for the Stable Baseline REST API. End-to-end agent-managed company brain — docs, diagrams, plans, and a self-learning Knowledge Graph. 196 tools across 18 categories.",
|
|
5
5
|
"homepage": "https://stablebaseline.io",
|
|
6
6
|
"repository": {
|
|
7
7
|
"type": "git",
|
package/src/types.generated.ts
CHANGED
|
@@ -75,7 +75,7 @@ export interface paths {
|
|
|
75
75
|
put?: never;
|
|
76
76
|
/**
|
|
77
77
|
* listArchitectureIcons
|
|
78
|
-
* @description SOFTWARE & CLOUD architecture icons ONLY (AWS, Azure, GCP, Docker, Kubernetes, databases, message queues, dev tools, etc.). This catalog has NO general/nature/science/people/business icons — so for any NON-technical topic (e.g. photosynthesis, biology, history, marketing), do NOT use this tool; instead put a relevant emoji directly in the element's label (
|
|
78
|
+
* @description SOFTWARE & CLOUD architecture icons ONLY (AWS, Azure, GCP, Docker, Kubernetes, databases, message queues, dev tools, etc.). This catalog has NO general/nature/science/people/business icons — so for any NON-technical topic (e.g. photosynthesis, biology, history, marketing), do NOT use this tool; instead put a relevant emoji directly in the element's label (for example a sun for sunlight, a droplet for water, a leaf for a plant). It returns nothing for off-domain queries by design — never force an unrelated tech logo onto a non-tech concept. Each result has an `iconPath` (e.g. 'dev/docker.svg'). TWO ways to use it: (1) on a WHITEBOARD, drop it via addWhiteboardElements({ type:'image', iconPath:'dev/docker.svg', x, y, width:96, height:96, text:'Docker' }); (2) in a D2 systems-architecture diagram, use the iconPath as-is in D2 code (e.g. icon: dev/docker.svg).
|
|
79
79
|
*/
|
|
80
80
|
post: operations["listArchitectureIcons"];
|
|
81
81
|
delete?: never;
|
|
@@ -915,7 +915,7 @@ export interface paths {
|
|
|
915
915
|
put?: never;
|
|
916
916
|
/**
|
|
917
917
|
* addWhiteboardElements
|
|
918
|
-
* @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. 'Risks
|
|
918
|
+
* @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.
|
|
919
919
|
*/
|
|
920
920
|
post: operations["addWhiteboardElements"];
|
|
921
921
|
delete?: never;
|
|
@@ -1155,7 +1155,7 @@ export interface paths {
|
|
|
1155
1155
|
put?: never;
|
|
1156
1156
|
/**
|
|
1157
1157
|
* reorderDocuments
|
|
1158
|
-
* @description MOVE documents between folders and/or reorder them — the batch filing tool. Pass [{documentId, position
|
|
1158
|
+
* @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).
|
|
1159
1159
|
*/
|
|
1160
1160
|
post: operations["reorderDocuments"];
|
|
1161
1161
|
delete?: never;
|
|
@@ -2263,7 +2263,7 @@ export interface paths {
|
|
|
2263
2263
|
*
|
|
2264
2264
|
* PICK THE MODE THAT FITS THE QUERY:
|
|
2265
2265
|
*
|
|
2266
|
-
* • mode='local' (default) — for SPECIFIC factual questions ("what does
|
|
2266
|
+
* • 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.
|
|
2267
2267
|
*
|
|
2268
2268
|
* • 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.
|
|
2269
2269
|
*
|
|
@@ -2918,7 +2918,7 @@ export interface paths {
|
|
|
2918
2918
|
put?: never;
|
|
2919
2919
|
/**
|
|
2920
2920
|
* createProject
|
|
2921
|
-
* @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
|
|
2921
|
+
* @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.
|
|
2922
2922
|
*/
|
|
2923
2923
|
post: operations["createProject"];
|
|
2924
2924
|
delete?: never;
|
|
@@ -3985,10 +3985,10 @@ export interface operations {
|
|
|
3985
3985
|
/** @description Natural language description of what you want to do. */
|
|
3986
3986
|
query?: string;
|
|
3987
3987
|
/**
|
|
3988
|
-
* @description Category filter.
|
|
3988
|
+
* @description Category filter. One of the 18 categories returned in each result's `category` field.
|
|
3989
3989
|
* @enum {string}
|
|
3990
3990
|
*/
|
|
3991
|
-
category?: "navigation" | "folders" | "documents" | "diagrams" | "images" | "data" | "improvements" | "plans" | "knowledge_graph" | "organization" | "members" | "teams" | "permissions" | "billing" | "kg_admin" | "settings" | "signup";
|
|
3991
|
+
category?: "navigation" | "folders" | "documents" | "diagrams" | "images" | "whiteboards" | "data" | "improvements" | "plans" | "knowledge_graph" | "organization" | "members" | "teams" | "permissions" | "billing" | "kg_admin" | "settings" | "signup";
|
|
3992
3992
|
};
|
|
3993
3993
|
};
|
|
3994
3994
|
};
|
|
@@ -9411,10 +9411,10 @@ export interface operations {
|
|
|
9411
9411
|
/** @description Documents to file. All must belong to the same project (a batch spanning projects is rejected). */
|
|
9412
9412
|
items: {
|
|
9413
9413
|
documentId: string;
|
|
9414
|
-
/** @description
|
|
9415
|
-
position: number;
|
|
9416
|
-
/** @description Optional. 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. */
|
|
9414
|
+
/** @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. */
|
|
9417
9415
|
folderId?: string | null;
|
|
9416
|
+
/** @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…. */
|
|
9417
|
+
position?: number;
|
|
9418
9418
|
}[];
|
|
9419
9419
|
};
|
|
9420
9420
|
};
|
|
@@ -10723,7 +10723,7 @@ export interface operations {
|
|
|
10723
10723
|
user_impact?: string;
|
|
10724
10724
|
why_now?: string;
|
|
10725
10725
|
/** @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 }`. */
|
|
10726
|
-
acceptance_criteria?: {
|
|
10726
|
+
acceptance_criteria?: (string | {
|
|
10727
10727
|
/** @description Optional — server mints one if omitted. Preserve on edits. */
|
|
10728
10728
|
id?: string;
|
|
10729
10729
|
text: string;
|
|
@@ -10733,7 +10733,7 @@ export interface operations {
|
|
|
10733
10733
|
updated_by?: string;
|
|
10734
10734
|
/** @description Server-stamped credential label. Echo back unchanged. */
|
|
10735
10735
|
updated_by_credential_name?: string;
|
|
10736
|
-
}[];
|
|
10736
|
+
})[];
|
|
10737
10737
|
/** @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. */
|
|
10738
10738
|
checklist?: {
|
|
10739
10739
|
/** @description Optional — server mints one if omitted. Preserve on edits. */
|
|
@@ -10909,7 +10909,7 @@ export interface operations {
|
|
|
10909
10909
|
user_impact?: string;
|
|
10910
10910
|
why_now?: string;
|
|
10911
10911
|
/** @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 }`. */
|
|
10912
|
-
acceptance_criteria?: {
|
|
10912
|
+
acceptance_criteria?: (string | {
|
|
10913
10913
|
/** @description Optional — server mints one if omitted. Preserve on edits. */
|
|
10914
10914
|
id?: string;
|
|
10915
10915
|
text: string;
|
|
@@ -10919,7 +10919,7 @@ export interface operations {
|
|
|
10919
10919
|
updated_by?: string;
|
|
10920
10920
|
/** @description Server-stamped credential label. Echo back unchanged. */
|
|
10921
10921
|
updated_by_credential_name?: string;
|
|
10922
|
-
}[];
|
|
10922
|
+
})[];
|
|
10923
10923
|
/** @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. */
|
|
10924
10924
|
checklist?: {
|
|
10925
10925
|
/** @description Optional — server mints one if omitted. Preserve on edits. */
|
|
@@ -13338,7 +13338,7 @@ export interface operations {
|
|
|
13338
13338
|
user_impact?: string;
|
|
13339
13339
|
why_now?: string;
|
|
13340
13340
|
/** @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 }`. */
|
|
13341
|
-
acceptance_criteria?: {
|
|
13341
|
+
acceptance_criteria?: (string | {
|
|
13342
13342
|
/** @description Optional — server mints one if omitted. Preserve on edits. */
|
|
13343
13343
|
id?: string;
|
|
13344
13344
|
text: string;
|
|
@@ -13348,7 +13348,7 @@ export interface operations {
|
|
|
13348
13348
|
updated_by?: string;
|
|
13349
13349
|
/** @description Server-stamped credential label. Echo back unchanged. */
|
|
13350
13350
|
updated_by_credential_name?: string;
|
|
13351
|
-
}[];
|
|
13351
|
+
})[];
|
|
13352
13352
|
/** @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. */
|
|
13353
13353
|
checklist?: {
|
|
13354
13354
|
/** @description Optional — server mints one if omitted. Preserve on edits. */
|
|
@@ -13706,7 +13706,7 @@ export interface operations {
|
|
|
13706
13706
|
user_impact?: string;
|
|
13707
13707
|
why_now?: string;
|
|
13708
13708
|
/** @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 }`. */
|
|
13709
|
-
acceptance_criteria?: {
|
|
13709
|
+
acceptance_criteria?: (string | {
|
|
13710
13710
|
/** @description Optional — server mints one if omitted. Preserve on edits. */
|
|
13711
13711
|
id?: string;
|
|
13712
13712
|
text: string;
|
|
@@ -13716,7 +13716,7 @@ export interface operations {
|
|
|
13716
13716
|
updated_by?: string;
|
|
13717
13717
|
/** @description Server-stamped credential label. Echo back unchanged. */
|
|
13718
13718
|
updated_by_credential_name?: string;
|
|
13719
|
-
}[];
|
|
13719
|
+
})[];
|
|
13720
13720
|
/** @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. */
|
|
13721
13721
|
checklist?: {
|
|
13722
13722
|
/** @description Optional — server mints one if omitted. Preserve on edits. */
|
|
@@ -17444,7 +17444,7 @@ export interface operations {
|
|
|
17444
17444
|
name: string;
|
|
17445
17445
|
/** @description Optional description. */
|
|
17446
17446
|
description?: string;
|
|
17447
|
-
/** @description Optional emoji icon. Defaults to
|
|
17447
|
+
/** @description Optional emoji icon. Defaults to a folder emoji to match the UI. */
|
|
17448
17448
|
icon?: string;
|
|
17449
17449
|
};
|
|
17450
17450
|
};
|