@stablebaseline/sdk 0.5.2 → 0.6.0
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 +47 -31
- package/dist/index.d.ts +47 -31
- package/openapi.json +178 -114
- package/package.json +2 -2
- package/src/types.generated.ts +47 -31
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;
|
|
@@ -854,7 +854,7 @@ interface paths {
|
|
|
854
854
|
put?: never;
|
|
855
855
|
/**
|
|
856
856
|
* listWhiteboards
|
|
857
|
-
* @description List the whiteboards in a project (hidden whiteboard-kind documents). Returns documentId, diagramId, title and timestamps for each.
|
|
857
|
+
* @description List AND grep the whiteboards in a project (hidden whiteboard-kind documents). `query` searches the title and friendlyId (substring by default; set isRegex:true for a regular expression, caseSensitive:true for exact case). This is the tool to find a board by name — listDocuments deliberately excludes whiteboards. Returns documentId, diagramId, title and timestamps for each.
|
|
858
858
|
*/
|
|
859
859
|
post: operations["listWhiteboards"];
|
|
860
860
|
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;
|
|
@@ -1674,11 +1674,11 @@ interface paths {
|
|
|
1674
1674
|
put?: never;
|
|
1675
1675
|
/**
|
|
1676
1676
|
* searchImprovements
|
|
1677
|
-
* @description
|
|
1677
|
+
* @description Ranked semantic search over IMPROVEMENTS AND TASKS — hybrid full-text + vector, so it matches meaning rather than just wording. Returns ranked { improvements }, each with a versionTimestamp you can pass straight to updateImprovement without a getImprovement round-trip.
|
|
1678
1678
|
*
|
|
1679
|
-
*
|
|
1679
|
+
* Improvements and tasks are one table (a task is an improvement with is_task=true), so both are searched by default. Pass types:["task"] or types:["improvement"] to narrow to one.
|
|
1680
1680
|
*
|
|
1681
|
-
*
|
|
1681
|
+
* This tool searches improvements and tasks ONLY. To find a document, whiteboard, plan or compliance item by name or friendly id, use kg_search({ query, artefactMetadataOnly: true }) — it matches title + friendly id + uuid across every artefact type and needs no knowledge graph. To search document CONTENT, use listDocuments.
|
|
1682
1682
|
*/
|
|
1683
1683
|
post: operations["searchImprovements"];
|
|
1684
1684
|
delete?: never;
|
|
@@ -2258,11 +2258,11 @@ interface paths {
|
|
|
2258
2258
|
put?: never;
|
|
2259
2259
|
/**
|
|
2260
2260
|
* kg_search
|
|
2261
|
-
* @description Unified Knowledge Graph KNOWLEDGE retrieval — facts, themes and relationships from INSIDE document CONTENT.
|
|
2261
|
+
* @description Unified Knowledge Graph KNOWLEDGE retrieval — facts, themes and relationships from INSIDE document CONTENT. To LOCATE AN ARTEFACT BY NAME OR ID rather than answer a question, pass artefactMetadataOnly:true — see below. Without that flag this tool retrieves knowledge from inside content and will not reliably find a thing by its title.
|
|
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
|
*
|
|
@@ -2278,6 +2278,9 @@ interface paths {
|
|
|
2278
2278
|
* - User asks 'how is X connected to Y' → 'path' (with both entity IDs)
|
|
2279
2279
|
* - User asks 'what's near entity X' → 'graph' (with srcEntityId)
|
|
2280
2280
|
* - 'local' returned nothing useful and the question is broad → retry with 'ppr'
|
|
2281
|
+
* - User wants to FIND a named artefact ("the GTM plan", "DOC-123", a uuid) → artefactMetadataOnly:true
|
|
2282
|
+
*
|
|
2283
|
+
* ARTEFACT-METADATA MODE (artefactMetadataOnly:true): ignores `mode` entirely and matches title + friendly id + uuid across EVERY artefact type — documents, whiteboards, plans, tasks, improvements, compliance frameworks. Returns a typed navigable list ({ artefacts: [{ result_type, id, friendly_id, title, snippet, document_id, project_id, href }] }). It reads no document content and needs no knowledge graph: unlike every other mode it is NOT limited to what has been ingested, so it still finds artefacts in projects where the KG is switched off. Narrow it with artefactTypes. To search inside document BODIES use listDocuments (full-content grep).
|
|
2281
2284
|
*/
|
|
2282
2285
|
post: operations["kg_search"];
|
|
2283
2286
|
delete?: never;
|
|
@@ -2917,7 +2920,7 @@ interface paths {
|
|
|
2917
2920
|
put?: never;
|
|
2918
2921
|
/**
|
|
2919
2922
|
* 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
|
|
2923
|
+
* @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
2924
|
*/
|
|
2922
2925
|
post: operations["createProject"];
|
|
2923
2926
|
delete?: never;
|
|
@@ -3984,10 +3987,10 @@ interface operations {
|
|
|
3984
3987
|
/** @description Natural language description of what you want to do. */
|
|
3985
3988
|
query?: string;
|
|
3986
3989
|
/**
|
|
3987
|
-
* @description Category filter.
|
|
3990
|
+
* @description Category filter. One of the 18 categories returned in each result's `category` field.
|
|
3988
3991
|
* @enum {string}
|
|
3989
3992
|
*/
|
|
3990
|
-
category?: "navigation" | "folders" | "documents" | "diagrams" | "images" | "data" | "improvements" | "plans" | "knowledge_graph" | "organization" | "members" | "teams" | "permissions" | "billing" | "kg_admin" | "settings" | "signup";
|
|
3993
|
+
category?: "navigation" | "folders" | "documents" | "diagrams" | "images" | "whiteboards" | "data" | "improvements" | "plans" | "knowledge_graph" | "organization" | "members" | "teams" | "permissions" | "billing" | "kg_admin" | "settings" | "signup";
|
|
3991
3994
|
};
|
|
3992
3995
|
};
|
|
3993
3996
|
};
|
|
@@ -7893,6 +7896,12 @@ interface operations {
|
|
|
7893
7896
|
content: {
|
|
7894
7897
|
"application/json": {
|
|
7895
7898
|
projectId: string;
|
|
7899
|
+
/** @description Grep across title and friendlyId. Substring by default; a regular expression when isRegex is true. */
|
|
7900
|
+
query?: string;
|
|
7901
|
+
/** @description Treat `query` as a regular expression. */
|
|
7902
|
+
isRegex?: boolean;
|
|
7903
|
+
/** @description Match case exactly. Default false. */
|
|
7904
|
+
caseSensitive?: boolean;
|
|
7896
7905
|
};
|
|
7897
7906
|
};
|
|
7898
7907
|
};
|
|
@@ -9410,10 +9419,10 @@ interface operations {
|
|
|
9410
9419
|
/** @description Documents to file. All must belong to the same project (a batch spanning projects is rejected). */
|
|
9411
9420
|
items: {
|
|
9412
9421
|
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. */
|
|
9422
|
+
/** @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
9423
|
folderId?: string | null;
|
|
9424
|
+
/** @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…. */
|
|
9425
|
+
position?: number;
|
|
9417
9426
|
}[];
|
|
9418
9427
|
};
|
|
9419
9428
|
};
|
|
@@ -10722,7 +10731,7 @@ interface operations {
|
|
|
10722
10731
|
user_impact?: string;
|
|
10723
10732
|
why_now?: string;
|
|
10724
10733
|
/** @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?: {
|
|
10734
|
+
acceptance_criteria?: (string | {
|
|
10726
10735
|
/** @description Optional — server mints one if omitted. Preserve on edits. */
|
|
10727
10736
|
id?: string;
|
|
10728
10737
|
text: string;
|
|
@@ -10732,7 +10741,7 @@ interface operations {
|
|
|
10732
10741
|
updated_by?: string;
|
|
10733
10742
|
/** @description Server-stamped credential label. Echo back unchanged. */
|
|
10734
10743
|
updated_by_credential_name?: string;
|
|
10735
|
-
}[];
|
|
10744
|
+
})[];
|
|
10736
10745
|
/** @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
10746
|
checklist?: {
|
|
10738
10747
|
/** @description Optional — server mints one if omitted. Preserve on edits. */
|
|
@@ -10908,7 +10917,7 @@ interface operations {
|
|
|
10908
10917
|
user_impact?: string;
|
|
10909
10918
|
why_now?: string;
|
|
10910
10919
|
/** @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?: {
|
|
10920
|
+
acceptance_criteria?: (string | {
|
|
10912
10921
|
/** @description Optional — server mints one if omitted. Preserve on edits. */
|
|
10913
10922
|
id?: string;
|
|
10914
10923
|
text: string;
|
|
@@ -10918,7 +10927,7 @@ interface operations {
|
|
|
10918
10927
|
updated_by?: string;
|
|
10919
10928
|
/** @description Server-stamped credential label. Echo back unchanged. */
|
|
10920
10929
|
updated_by_credential_name?: string;
|
|
10921
|
-
}[];
|
|
10930
|
+
})[];
|
|
10922
10931
|
/** @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
10932
|
checklist?: {
|
|
10924
10933
|
/** @description Optional — server mints one if omitted. Preserve on edits. */
|
|
@@ -11942,18 +11951,16 @@ interface operations {
|
|
|
11942
11951
|
requestBody?: {
|
|
11943
11952
|
content: {
|
|
11944
11953
|
"application/json": {
|
|
11945
|
-
/** @description Search query — a name fragment or a friendly id. */
|
|
11954
|
+
/** @description Search query — meaning, a name fragment, or a friendly id (e.g. "IMP-2", "TAS-7"). */
|
|
11946
11955
|
query: string;
|
|
11947
|
-
/** @description
|
|
11948
|
-
types?: ("
|
|
11956
|
+
/** @description Narrow to one kind. Omit (or pass both) to search improvements and tasks together. Other artefact types are NOT accepted here — use kg_search with artefactMetadataOnly:true for those. */
|
|
11957
|
+
types?: ("improvement" | "task")[];
|
|
11949
11958
|
/** @description Limit to a project. */
|
|
11950
11959
|
projectId?: string;
|
|
11951
11960
|
/** @description Limit to a workspace. */
|
|
11952
11961
|
workspaceId?: string;
|
|
11953
|
-
/** @description Max results (default 20
|
|
11962
|
+
/** @description Max results (default 20, max 50). */
|
|
11954
11963
|
limit?: number;
|
|
11955
|
-
/** @description Pagination offset (cross-artefact mode). */
|
|
11956
|
-
offset?: number;
|
|
11957
11964
|
};
|
|
11958
11965
|
};
|
|
11959
11966
|
};
|
|
@@ -13337,7 +13344,7 @@ interface operations {
|
|
|
13337
13344
|
user_impact?: string;
|
|
13338
13345
|
why_now?: string;
|
|
13339
13346
|
/** @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?: {
|
|
13347
|
+
acceptance_criteria?: (string | {
|
|
13341
13348
|
/** @description Optional — server mints one if omitted. Preserve on edits. */
|
|
13342
13349
|
id?: string;
|
|
13343
13350
|
text: string;
|
|
@@ -13347,7 +13354,7 @@ interface operations {
|
|
|
13347
13354
|
updated_by?: string;
|
|
13348
13355
|
/** @description Server-stamped credential label. Echo back unchanged. */
|
|
13349
13356
|
updated_by_credential_name?: string;
|
|
13350
|
-
}[];
|
|
13357
|
+
})[];
|
|
13351
13358
|
/** @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
13359
|
checklist?: {
|
|
13353
13360
|
/** @description Optional — server mints one if omitted. Preserve on edits. */
|
|
@@ -13705,7 +13712,7 @@ interface operations {
|
|
|
13705
13712
|
user_impact?: string;
|
|
13706
13713
|
why_now?: string;
|
|
13707
13714
|
/** @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?: {
|
|
13715
|
+
acceptance_criteria?: (string | {
|
|
13709
13716
|
/** @description Optional — server mints one if omitted. Preserve on edits. */
|
|
13710
13717
|
id?: string;
|
|
13711
13718
|
text: string;
|
|
@@ -13715,7 +13722,7 @@ interface operations {
|
|
|
13715
13722
|
updated_by?: string;
|
|
13716
13723
|
/** @description Server-stamped credential label. Echo back unchanged. */
|
|
13717
13724
|
updated_by_credential_name?: string;
|
|
13718
|
-
}[];
|
|
13725
|
+
})[];
|
|
13719
13726
|
/** @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
13727
|
checklist?: {
|
|
13721
13728
|
/** @description Optional — server mints one if omitted. Preserve on edits. */
|
|
@@ -14714,8 +14721,17 @@ interface operations {
|
|
|
14714
14721
|
requestBody?: {
|
|
14715
14722
|
content: {
|
|
14716
14723
|
"application/json": {
|
|
14717
|
-
/** @description Natural-language query. Required for local/global/ppr; optional for graph (use srcEntityId instead). */
|
|
14724
|
+
/** @description Natural-language query. Required for local/global/ppr; optional for graph (use srcEntityId instead). With artefactMetadataOnly:true this is the artefact name, friendly id or uuid to find. */
|
|
14718
14725
|
query?: string;
|
|
14726
|
+
/**
|
|
14727
|
+
* @description Find artefacts BY NAME/ID instead of retrieving knowledge. Matches title + friendly id + uuid only — never document content — across all artefact types, and does not require the knowledge graph to be enabled. Default false.
|
|
14728
|
+
* @default false
|
|
14729
|
+
*/
|
|
14730
|
+
artefactMetadataOnly?: boolean;
|
|
14731
|
+
/** @description Only with artefactMetadataOnly:true. Restrict the search to these artefact types. Omit to search all of them. Unknown values are rejected rather than ignored. */
|
|
14732
|
+
artefactTypes?: ("document" | "whiteboard" | "improvement" | "task" | "plan" | "compliance")[];
|
|
14733
|
+
/** @description Only with artefactMetadataOnly:true. Skip this many results for paging. */
|
|
14734
|
+
offset?: number;
|
|
14719
14735
|
/**
|
|
14720
14736
|
* @description Retrieval strategy. See tool description for when to use each — strongly prefer 'global' for thematic/overview questions.
|
|
14721
14737
|
* @default local
|
|
@@ -17443,7 +17459,7 @@ interface operations {
|
|
|
17443
17459
|
name: string;
|
|
17444
17460
|
/** @description Optional description. */
|
|
17445
17461
|
description?: string;
|
|
17446
|
-
/** @description Optional emoji icon. Defaults to
|
|
17462
|
+
/** @description Optional emoji icon. Defaults to a folder emoji to match the UI. */
|
|
17447
17463
|
icon?: string;
|
|
17448
17464
|
};
|
|
17449
17465
|
};
|