@soat/sdk 0.26.0 → 0.27.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/dist/index.cjs CHANGED
@@ -1198,7 +1198,7 @@ var AuditLog = class {
1198
1198
  /**
1199
1199
  * List audit entries
1200
1200
  *
1201
- * Returns audit-log entries visible to the caller, newest first. All filters are optional and combine with AND. `resource_srn` is a prefix match (e.g. `soat:{project}:secret:` matches every secret action); every other filter is exact.
1201
+ * Returns audit-log entries visible to the caller, newest first. All filters are optional and combine with AND. `resource_srn` is a prefix match (e.g. `srn:{project}:secret:` matches every secret action); every other filter is exact.
1202
1202
  */
1203
1203
  static listAuditEntries(options) {
1204
1204
  return (options?.client ?? client).get({
@@ -2246,7 +2246,7 @@ var Formations = class {
2246
2246
  *
2247
2247
  * Validates the template, creates the formation record, then provisions all declared resources in dependency order.
2248
2248
  *
2249
- * A **template-shape** error is refused with `400`. A **deploy** failure is not: the operation ran, so the formation is returned with `201` and `status: "failed"`, and `error` explains why (the resources created before the failure are rolled back). Read `status` — a `2xx` here means the deploy was attempted, not that it worked. The `soat` CLI exits non-zero on that body so `create-formation && …` does not lie.
2249
+ * A **template-shape** error is refused with `400`. A **deploy** failure is not: the operation ran, so the formation is returned with `201` and `status: "failed"`, and `error` explains why (the resources created before the failure are rolled back). Read `status` — a `2xx` here means the deploy was attempted, not that it worked. The `builtin` CLI exits non-zero on that body so `create-formation && …` does not lie.
2250
2250
  *
2251
2251
  */
2252
2252
  static createFormation(options) {
@@ -2291,7 +2291,7 @@ var Formations = class {
2291
2291
  *
2292
2292
  * Applies a new template to the formation. Resources are created, updated, or deleted to reconcile the current state with the desired state.
2293
2293
  *
2294
- * A **template-shape** error is refused with `400`. A **deploy** failure is not: the operation ran, so the formation is returned with `200` and `status: "failed"`, and `error` explains why. Read `status` — a `2xx` here means the deploy was attempted, not that it worked. The `soat` CLI exits non-zero on that body so `update-formation && …` does not lie.
2294
+ * A **template-shape** error is refused with `400`. A **deploy** failure is not: the operation ran, so the formation is returned with `200` and `status: "failed"`, and `error` explains why. Read `status` — a `2xx` here means the deploy was attempted, not that it worked. The `builtin` CLI exits non-zero on that body so `update-formation && …` does not lie.
2295
2295
  *
2296
2296
  */
2297
2297
  static updateFormation(options) {
@@ -2408,7 +2408,7 @@ var Guardrails = class {
2408
2408
  /**
2409
2409
  * Create a guardrail
2410
2410
  *
2411
- * Creates a new guardrail in the project, archiving its document as version 1. The `document` is validated on write: `class` must be a literal (A/B/C/D) or a JSON Logic expression, and every variable it (and `guard`) reference must resolve to the `args.*` / `context.*` / `soat.*` namespaces — an out-of-catalog `soat.*` key is rejected with 400.
2411
+ * Creates a new guardrail in the project, archiving its document as version 1. The `document` is validated on write: `class` must be a literal (A/B/C/D) or a JSON Logic expression, and every variable it (and `guard`) reference must resolve to the `args.*` / `context.*` / `runtime.*` namespaces — an out-of-catalog `runtime.*` key is rejected with 400.
2412
2412
  *
2413
2413
  */
2414
2414
  static createGuardrail(options) {
@@ -2504,7 +2504,7 @@ var Guardrails = class {
2504
2504
  /**
2505
2505
  * Dry-run evaluate a guardrail
2506
2506
  *
2507
- * Runs the full evaluation pipeline — the `class` expression, the guard, the context tool per `context_mode`, live `soat.*` resolution — against caller-supplied `args` and `guardrail_context`, and returns the exact `guardrail_evaluation` record a real call would produce. Nothing executes, no approval item is filed, and no activity entry is written. This is the adoption path: preview a document's decisions against production-shaped calls before attaching it — or before editing a widely-attached one. Pass an optional `tool_id` to resolve `soat.tool.*`.
2507
+ * Runs the full evaluation pipeline — the `class` expression, the guard, the context tool per `context_mode`, live `runtime.*` resolution — against caller-supplied `args` and `guardrail_context`, and returns the exact `guardrail_evaluation` record a real call would produce. Nothing executes, no approval item is filed, and no activity entry is written. This is the adoption path: preview a document's decisions against production-shaped calls before attaching it — or before editing a widely-attached one. Pass an optional `tool_id` to resolve `runtime.tool.*`.
2508
2508
  *
2509
2509
  */
2510
2510
  static evaluateGuardrail(options) {
@@ -3651,8 +3651,8 @@ var Tools = class {
3651
3651
  /**
3652
3652
  * Call a tool
3653
3653
  *
3654
- * Directly invokes a tool and returns its output. Supported for `http`, `soat`, `mcp`, and `pipeline` tools. `client` tools cannot be invoked server-side and will return 422. A `pipeline` tool runs its declared steps in order and returns the mapped `output` (or the last step's output); `action` is ignored and `input` is the pipeline input.
3655
- * For `soat` and `mcp` tools the `action` field is required and identifies which action (SOAT) or tool name (MCP) to invoke. For `http` tools `action` is ignored. When a `soat` or `mcp` tool declares an `actions` allowlist, an action outside it is rejected with `400 VALIDATION_FAILED` ("not available on this tool") before any outbound request is made.
3654
+ * Directly invokes a tool and returns its output. Supported for `http`, `builtin`, `mcp`, and `pipeline` tools. `client` tools cannot be invoked server-side and will return 422. A `pipeline` tool runs its declared steps in order and returns the mapped `output` (or the last step's output); `action` is ignored and `input` is the pipeline input.
3655
+ * For `builtin` and `mcp` tools the `action` field is required and identifies which action (SOAT) or tool name (MCP) to invoke. For `http` tools `action` is ignored. When a `builtin` or `mcp` tool declares an `actions` allowlist, an action outside it is rejected with `400 VALIDATION_FAILED` ("not available on this tool") before any outbound request is made.
3656
3656
  * `preset_parameters` stored on the tool are merged with the caller-supplied `input` before execution; preset keys take lower precedence.
3657
3657
  *
3658
3658
  */
package/dist/index.d.cts CHANGED
@@ -862,7 +862,7 @@ type CreateAgentGenerationRequest = {
862
862
  */
863
863
  max_call_depth?: number;
864
864
  /**
865
- * Key-value pairs forwarded as `X-Soat-Context-<key>` headers on every `http`, `mcp` and `soat` tool call in this generation. The header name is the deployment's configured context prefix (`X-Soat-Context-` by default) plus the key verbatim — no character is re-cased. Keys are never case-converted — they round-trip exactly as sent. An invalid or colliding key is rejected with `400 INVALID_TOOL_CONTEXT_KEY`.
865
+ * Key-value pairs forwarded as `X-Soat-Context-<key>` headers on every `http`, `mcp` and `builtin` tool call in this generation. The header name is the deployment's configured context prefix (`X-Soat-Context-` by default) plus the key verbatim — no character is re-cased. Keys are never case-converted — they round-trip exactly as sent. An invalid or colliding key is rejected with `400 INVALID_TOOL_CONTEXT_KEY`.
866
866
  */
867
867
  tool_context?: {
868
868
  [key: string]: string;
@@ -906,7 +906,7 @@ type ToolOutputMessageContent = {
906
906
  */
907
907
  tool_id: string;
908
908
  /**
909
- * Optional action name for tools that require action selection (for example soat and mcp tools).
909
+ * Optional action name for tools that require action selection (for example builtin and mcp tools).
910
910
  */
911
911
  action?: string | null;
912
912
  /**
@@ -1205,7 +1205,7 @@ type ApprovalItem = {
1205
1205
  proposed_action?: {
1206
1206
  tool_id?: string;
1207
1207
  /**
1208
- * Resolved action name (the soat/mcp action) for `tool_call`-origin items — always present there, even for single-action tools. Omitted for `node`-origin items, whose downstream execution is wired by a separate `tool` node in the graph.
1208
+ * Resolved action name (the builtin/mcp action) for `tool_call`-origin items — always present there, even for single-action tools. Omitted for `node`-origin items, whose downstream execution is wired by a separate `tool` node in the graph.
1209
1209
  */
1210
1210
  action?: string;
1211
1211
  arguments?: {
@@ -1303,7 +1303,7 @@ type AuditEntry = {
1303
1303
  */
1304
1304
  action?: string;
1305
1305
  /**
1306
- * SRN the action targeted (type-level `soat:{project}:{type}:*` on creates)
1306
+ * SRN the action targeted (type-level `srn:{project}:{type}:*` on creates)
1307
1307
  */
1308
1308
  resource_srn?: string | null;
1309
1309
  /**
@@ -1733,11 +1733,11 @@ type ToolScorer = {
1733
1733
  */
1734
1734
  name: string;
1735
1735
  /**
1736
- * The tool that scores each item. It must belong to the eval's project and be server-callable (`http`, `mcp`, `soat`, or `pipeline` — a `client` tool pauses for a calling client an eval run does not have).
1736
+ * The tool that scores each item. It must belong to the eval's project and be server-callable (`http`, `mcp`, `builtin`, or `pipeline` — a `client` tool pauses for a calling client an eval run does not have).
1737
1737
  */
1738
1738
  tool_id: string;
1739
1739
  /**
1740
- * The operation to invoke; required when the tool type is `soat` or `mcp`.
1740
+ * The operation to invoke; required when the tool type is `builtin` or `mcp`.
1741
1741
  */
1742
1742
  action?: string | null;
1743
1743
  /**
@@ -2381,7 +2381,7 @@ type ToolResourceProperties = {
2381
2381
  */
2382
2382
  name: string;
2383
2383
  /**
2384
- * Tool type hint (e.g. http, mcp, soat, pipeline)
2384
+ * Tool type hint (e.g. http, mcp, builtin, pipeline)
2385
2385
  */
2386
2386
  type?: string | null;
2387
2387
  /**
@@ -2439,7 +2439,7 @@ type ToolResourceProperties = {
2439
2439
  } | null;
2440
2440
  } | null;
2441
2441
  /**
2442
- * Allowlist of actions the tool exposes. For `soat` tools: SOAT platform action names. For `mcp` tools: an optional allowlist of MCP tool names to scope the server surface (`null` exposes every tool).
2442
+ * Allowlist of actions the tool exposes. For `builtin` tools: SOAT platform action names. For `mcp` tools: an optional allowlist of MCP tool names to scope the server surface (`null` exposes every tool).
2443
2443
  */
2444
2444
  actions?: Array<string> | null;
2445
2445
  /**
@@ -2700,7 +2700,7 @@ type TriggerResourceProperties = {
2700
2700
  */
2701
2701
  target_id: string;
2702
2702
  /**
2703
- * Tool targets only — the action for soat/mcp tools
2703
+ * Tool targets only — the action for builtin/mcp tools
2704
2704
  */
2705
2705
  action?: string | null;
2706
2706
  /**
@@ -2911,7 +2911,7 @@ type IngestionRuleResourceProperties = {
2911
2911
  */
2912
2912
  agent_id?: string | null;
2913
2913
  /**
2914
- * Operation id, required for soat/mcp tool converters
2914
+ * Operation id, required for builtin/mcp tool converters
2915
2915
  */
2916
2916
  action?: string | null;
2917
2917
  /**
@@ -3588,7 +3588,7 @@ type GenerationTranscript = {
3588
3588
  content_redacted_by_principal_id?: string | null;
3589
3589
  };
3590
3590
  /**
3591
- * The action-class document. `class` maps a call to an action class; `guard` gates class-B autonomy. Both are single JSON Logic expressions over the `args.*` / `context.*` / `soat.*` namespaces.
3591
+ * The action-class document. `class` maps a call to an action class; `guard` gates class-B autonomy. Both are single JSON Logic expressions over the `args.*` / `context.*` / `runtime.*` namespaces.
3592
3592
  *
3593
3593
  */
3594
3594
  type GuardrailDocument = {
@@ -4532,7 +4532,7 @@ type StartRunRequest = {
4532
4532
  [key: string]: unknown;
4533
4533
  };
4534
4534
  /**
4535
- * Key-value pairs forwarded as `X-Soat-Context-<key>` headers on every `http`, `mcp` and `soat` tool call made by an agent node of this run — including the agents of any child run a `loop` or `sub_orchestration` node starts. The header name is `X-Soat-Context-` plus the key verbatim; no character is re-cased.
4535
+ * Key-value pairs forwarded as `X-Soat-Context-<key>` headers on every `http`, `mcp` and `builtin` tool call made by an agent node of this run — including the agents of any child run a `loop` or `sub_orchestration` node starts. The header name is `X-Soat-Context-` plus the key verbatim; no character is re-cased.
4536
4536
  *
4537
4537
  * The bag is stored on the run and re-read on every step, so it survives an `awaiting_input` pause, a `sleeping` wait, a background worker drive and a crash redrive. A key that is not a valid HTTP header name, or two keys that map to the same header, are rejected with `400 INVALID_TOOL_CONTEXT_KEY` and no run is created.
4538
4538
  *
@@ -4734,7 +4734,7 @@ type SessionRecord = {
4734
4734
  created_at?: Date;
4735
4735
  updated_at?: Date;
4736
4736
  /**
4737
- * Key-value pairs forwarded as `X-Soat-Context-<key>` headers on every `http`, `mcp` and `soat` tool call in this session. The header name is the deployment's configured context prefix (`X-Soat-Context-` by default) plus the key verbatim — no character is re-cased. Keys are never case-converted — they round-trip exactly as sent. A key that is not a valid HTTP header name, or two keys that map to the same header, are rejected with `400 INVALID_TOOL_CONTEXT_KEY`.
4737
+ * Key-value pairs forwarded as `X-Soat-Context-<key>` headers on every `http`, `mcp` and `builtin` tool call in this session. The header name is the deployment's configured context prefix (`X-Soat-Context-` by default) plus the key verbatim — no character is re-cased. Keys are never case-converted — they round-trip exactly as sent. A key that is not a valid HTTP header name, or two keys that map to the same header, are rejected with `400 INVALID_TOOL_CONTEXT_KEY`.
4738
4738
  */
4739
4739
  tool_context?: {
4740
4740
  [key: string]: string;
@@ -4811,7 +4811,7 @@ type CreateSessionRequest = {
4811
4811
  */
4812
4812
  auto_generate?: boolean;
4813
4813
  /**
4814
- * Key-value pairs forwarded as `X-Soat-Context-<key>` headers on every `http`, `mcp` and `soat` tool call in this session. The header name is the deployment's configured context prefix (`X-Soat-Context-` by default) plus the key verbatim — no character is re-cased. Keys are never case-converted — they round-trip exactly as sent. A key that is not a valid HTTP header name, or two keys that map to the same header, are rejected with `400 INVALID_TOOL_CONTEXT_KEY`.
4814
+ * Key-value pairs forwarded as `X-Soat-Context-<key>` headers on every `http`, `mcp` and `builtin` tool call in this session. The header name is the deployment's configured context prefix (`X-Soat-Context-` by default) plus the key verbatim — no character is re-cased. Keys are never case-converted — they round-trip exactly as sent. A key that is not a valid HTTP header name, or two keys that map to the same header, are rejected with `400 INVALID_TOOL_CONTEXT_KEY`.
4815
4815
  */
4816
4816
  tool_context?: {
4817
4817
  [key: string]: string;
@@ -4840,7 +4840,7 @@ type UpdateSessionRequest = {
4840
4840
  */
4841
4841
  auto_generate?: boolean;
4842
4842
  /**
4843
- * Key-value pairs forwarded as `X-Soat-Context-<key>` headers on every `http`, `mcp` and `soat` tool call in this session. The header name is the deployment's configured context prefix (`X-Soat-Context-` by default) plus the key verbatim — no character is re-cased. Keys are never case-converted — they round-trip exactly as sent. A key that is not a valid HTTP header name, or two keys that map to the same header, are rejected with `400 INVALID_TOOL_CONTEXT_KEY`.
4843
+ * Key-value pairs forwarded as `X-Soat-Context-<key>` headers on every `http`, `mcp` and `builtin` tool call in this session. The header name is the deployment's configured context prefix (`X-Soat-Context-` by default) plus the key verbatim — no character is re-cased. Keys are never case-converted — they round-trip exactly as sent. A key that is not a valid HTTP header name, or two keys that map to the same header, are rejected with `400 INVALID_TOOL_CONTEXT_KEY`.
4844
4844
  */
4845
4845
  tool_context?: {
4846
4846
  [key: string]: string;
@@ -4862,7 +4862,7 @@ type AddSessionMessageRequest = {
4862
4862
  */
4863
4863
  message: string;
4864
4864
  /**
4865
- * Key-value pairs forwarded as `X-Soat-Context-<key>` headers on every `http`, `mcp` and `soat` tool call in this generation. The header name is the deployment's configured context prefix (`X-Soat-Context-` by default) plus the key verbatim — no character is re-cased. Keys are never case-converted — they round-trip exactly as sent. An invalid or colliding key is rejected with `400 INVALID_TOOL_CONTEXT_KEY`.
4865
+ * Key-value pairs forwarded as `X-Soat-Context-<key>` headers on every `http`, `mcp` and `builtin` tool call in this generation. The header name is the deployment's configured context prefix (`X-Soat-Context-` by default) plus the key verbatim — no character is re-cased. Keys are never case-converted — they round-trip exactly as sent. An invalid or colliding key is rejected with `400 INVALID_TOOL_CONTEXT_KEY`.
4866
4866
  */
4867
4867
  tool_context?: {
4868
4868
  [key: string]: string;
@@ -4878,7 +4878,7 @@ type AddSessionMessageRequest = {
4878
4878
  */
4879
4879
  document_id: string;
4880
4880
  /**
4881
- * Key-value pairs forwarded as `X-Soat-Context-<key>` headers on every `http`, `mcp` and `soat` tool call in this generation. The header name is the deployment's configured context prefix (`X-Soat-Context-` by default) plus the key verbatim — no character is re-cased. Keys are never case-converted — they round-trip exactly as sent. An invalid or colliding key is rejected with `400 INVALID_TOOL_CONTEXT_KEY`.
4881
+ * Key-value pairs forwarded as `X-Soat-Context-<key>` headers on every `http`, `mcp` and `builtin` tool call in this generation. The header name is the deployment's configured context prefix (`X-Soat-Context-` by default) plus the key verbatim — no character is re-cased. Keys are never case-converted — they round-trip exactly as sent. An invalid or colliding key is rejected with `400 INVALID_TOOL_CONTEXT_KEY`.
4882
4882
  */
4883
4883
  tool_context?: {
4884
4884
  [key: string]: string;
@@ -4904,7 +4904,7 @@ type GenerateSessionRequest = {
4904
4904
  */
4905
4905
  model?: string;
4906
4906
  /**
4907
- * Key-value pairs forwarded as `X-Soat-Context-<key>` headers on every `http`, `mcp` and `soat` tool call in this generation. The header name is the deployment's configured context prefix (`X-Soat-Context-` by default) plus the key verbatim — no character is re-cased. Keys are never case-converted — they round-trip exactly as sent. An invalid or colliding key is rejected with `400 INVALID_TOOL_CONTEXT_KEY`.
4907
+ * Key-value pairs forwarded as `X-Soat-Context-<key>` headers on every `http`, `mcp` and `builtin` tool call in this generation. The header name is the deployment's configured context prefix (`X-Soat-Context-` by default) plus the key verbatim — no character is re-cased. Keys are never case-converted — they round-trip exactly as sent. An invalid or colliding key is rejected with `400 INVALID_TOOL_CONTEXT_KEY`.
4908
4908
  */
4909
4909
  tool_context?: {
4910
4910
  [key: string]: string;
@@ -5056,7 +5056,7 @@ type CreateTaskRequest = {
5056
5056
  */
5057
5057
  state?: string;
5058
5058
  /**
5059
- * Key-value pairs forwarded as `X-Soat-Context-<key>` headers on every `http`, `mcp` and `soat` tool call made by this task's automation dispatches — the agent generations a state's `on_enter` starts, and the agent nodes of any orchestration run it starts. The header name is `X-Soat-Context-` plus the key verbatim; no character is re-cased.
5059
+ * Key-value pairs forwarded as `X-Soat-Context-<key>` headers on every `http`, `mcp` and `builtin` tool call made by this task's automation dispatches — the agent generations a state's `on_enter` starts, and the agent nodes of any orchestration run it starts. The header name is `X-Soat-Context-` plus the key verbatim; no character is re-cased.
5060
5060
  * Creation is the task's first move, so this is the bag the entry state's `on_enter` runs with. Each transition may replace it (see `TransitionTaskRequest.tool_context`).
5061
5061
  * The reserved identity keys (`sessionId`, `actorId`, `actorExternalId`) are stripped in any casing and re-derived server-side, so a task-dispatched generation cannot forge them. A key outside the HTTP header-name grammar is rejected with `INVALID_TOOL_CONTEXT_KEY` (400).
5062
5062
  * Write-only: the stored bag is never returned by any task read, and it is cleared when the task reaches a terminal state.
@@ -5104,7 +5104,7 @@ type Tool = {
5104
5104
  /**
5105
5105
  * Tool type
5106
5106
  */
5107
- type?: 'http' | 'client' | 'mcp' | 'soat' | 'pipeline';
5107
+ type?: 'http' | 'client' | 'mcp' | 'builtin' | 'pipeline';
5108
5108
  /**
5109
5109
  * What the tool does (sent to the model)
5110
5110
  */
@@ -5138,7 +5138,7 @@ type Tool = {
5138
5138
  [key: string]: unknown;
5139
5139
  } | null;
5140
5140
  /**
5141
- * Allowlist of actions to expose. For `soat` tools: SOAT platform action names (required). For `mcp` tools: an optional allowlist of MCP tool names — when set, only those tools are exposed to the model and callable via `/call`; when `null`, the entire MCP server surface is exposed. Ignored for other tool types.
5141
+ * Allowlist of actions to expose. For `builtin` tools: SOAT platform action names (required). For `mcp` tools: an optional allowlist of MCP tool names — when set, only those tools are exposed to the model and callable via `/call`; when `null`, the entire MCP server surface is exposed. Ignored for other tool types.
5142
5142
  */
5143
5143
  actions?: Array<string> | null;
5144
5144
  /**
@@ -5150,7 +5150,7 @@ type Tool = {
5150
5150
  */
5151
5151
  context_keys?: Array<string> | null;
5152
5152
  /**
5153
- * Fixed parameters merged into every soat tool call. Keys matching fields in the action's input schema are removed from the schema shown to the model and injected automatically at execution time.
5153
+ * Fixed parameters merged into every builtin tool call. Keys matching fields in the action's input schema are removed from the schema shown to the model and injected automatically at execution time.
5154
5154
  */
5155
5155
  preset_parameters?: {
5156
5156
  [key: string]: unknown;
@@ -5162,7 +5162,7 @@ type Tool = {
5162
5162
  [key: string]: unknown;
5163
5163
  } | null;
5164
5164
  /**
5165
- * Universal JSON Logic mapping applied to the tool's raw result, for every tool type (`http`, `mcp`, `soat`, `pipeline`, `client`). Evaluated over `{ output: <raw result>, input: <merged input> }`, so `{ "var": "output.text" }` extracts a bare scalar field instead of requiring a wrapping `pipeline` tool, and `{ "var": "input.title" }` echoes back a field of the request that produced the response. For `pipeline` tools this runs *after* the pipeline's own `output` mapping, over that mapping's result.
5165
+ * Universal JSON Logic mapping applied to the tool's raw result, for every tool type (`http`, `mcp`, `builtin`, `pipeline`, `client`). Evaluated over `{ output: <raw result>, input: <merged input> }`, so `{ "var": "output.text" }` extracts a bare scalar field instead of requiring a wrapping `pipeline` tool, and `{ "var": "input.title" }` echoes back a field of the request that produced the response. For `pipeline` tools this runs *after* the pipeline's own `output` mapping, over that mapping's result.
5166
5166
  */
5167
5167
  output_mapping?: {
5168
5168
  [key: string]: unknown;
@@ -5186,7 +5186,7 @@ type CreateToolRequest = {
5186
5186
  /**
5187
5187
  * Tool type (default http)
5188
5188
  */
5189
- type?: 'http' | 'client' | 'mcp' | 'soat' | 'pipeline';
5189
+ type?: 'http' | 'client' | 'mcp' | 'builtin' | 'pipeline';
5190
5190
  /**
5191
5191
  * What the tool does
5192
5192
  */
@@ -5220,7 +5220,7 @@ type CreateToolRequest = {
5220
5220
  [key: string]: unknown;
5221
5221
  };
5222
5222
  /**
5223
- * Allowlist of actions. For `soat` tools: SOAT platform action names (required). For `mcp` tools: an optional allowlist of MCP tool names to scope the server surface — omit or set `null` to expose every tool the MCP server offers. Ignored for other tool types.
5223
+ * Allowlist of actions. For `builtin` tools: SOAT platform action names (required). For `mcp` tools: an optional allowlist of MCP tool names to scope the server surface — omit or set `null` to expose every tool the MCP server offers. Ignored for other tool types.
5224
5224
  */
5225
5225
  actions?: Array<string>;
5226
5226
  /**
@@ -5232,7 +5232,7 @@ type CreateToolRequest = {
5232
5232
  */
5233
5233
  context_keys?: Array<string> | null;
5234
5234
  /**
5235
- * Fixed parameters merged into every soat tool call. Keys matching fields in the action's input schema are removed from the schema shown to the model and injected automatically at execution time.
5235
+ * Fixed parameters merged into every builtin tool call. Keys matching fields in the action's input schema are removed from the schema shown to the model and injected automatically at execution time.
5236
5236
  */
5237
5237
  preset_parameters?: {
5238
5238
  [key: string]: unknown;
@@ -5256,7 +5256,7 @@ type CreateToolRequest = {
5256
5256
  };
5257
5257
  type UpdateToolRequest = {
5258
5258
  name?: string;
5259
- type?: 'http' | 'client' | 'mcp' | 'soat' | 'pipeline';
5259
+ type?: 'http' | 'client' | 'mcp' | 'builtin' | 'pipeline';
5260
5260
  description?: string | null;
5261
5261
  parameters?: {
5262
5262
  [key: string]: unknown;
@@ -5284,7 +5284,7 @@ type UpdateToolRequest = {
5284
5284
  [key: string]: unknown;
5285
5285
  } | null;
5286
5286
  /**
5287
- * Allowlist of actions. For `soat` tools: SOAT platform action names. For `mcp` tools: an optional allowlist of MCP tool names to scope the server surface (`null` exposes every tool). Ignored for other tool types.
5287
+ * Allowlist of actions. For `builtin` tools: SOAT platform action names. For `mcp` tools: an optional allowlist of MCP tool names to scope the server surface (`null` exposes every tool). Ignored for other tool types.
5288
5288
  */
5289
5289
  actions?: Array<string> | null;
5290
5290
  /**
@@ -5296,7 +5296,7 @@ type UpdateToolRequest = {
5296
5296
  */
5297
5297
  context_keys?: Array<string> | null;
5298
5298
  /**
5299
- * Fixed parameters merged into every soat tool call. Keys matching fields in the action's input schema are removed from the schema shown to the model and injected automatically at execution time.
5299
+ * Fixed parameters merged into every builtin tool call. Keys matching fields in the action's input schema are removed from the schema shown to the model and injected automatically at execution time.
5300
5300
  */
5301
5301
  preset_parameters?: {
5302
5302
  [key: string]: unknown;
@@ -5320,7 +5320,7 @@ type UpdateToolRequest = {
5320
5320
  };
5321
5321
  type CallToolRequest = {
5322
5322
  /**
5323
- * For `soat` tools: the action name (must be in the tool's `actions` list). For `mcp` tools: the MCP tool name to invoke (must be in the tool's `actions` allowlist when one is set, and must not be in its `denied_actions` denylist). Ignored for `http` tools.
5323
+ * For `builtin` tools: the action name (must be in the tool's `actions` list). For `mcp` tools: the MCP tool name to invoke (must be in the tool's `actions` allowlist when one is set, and must not be in its `denied_actions` denylist). Ignored for `http` tools.
5324
5324
  *
5325
5325
  */
5326
5326
  action?: string;
@@ -5448,7 +5448,7 @@ type Trigger = {
5448
5448
  */
5449
5449
  target_id?: string;
5450
5450
  /**
5451
- * Tool targets only — the action for soat/mcp tools
5451
+ * Tool targets only — the action for builtin/mcp tools
5452
5452
  */
5453
5453
  action?: string | null;
5454
5454
  /**
@@ -5490,7 +5490,7 @@ type CreateTriggerRequest = {
5490
5490
  target_type: 'orchestration' | 'agent' | 'tool' | 'eval';
5491
5491
  target_id: string;
5492
5492
  /**
5493
- * Tool targets only — the action for soat/mcp tools
5493
+ * Tool targets only — the action for builtin/mcp tools
5494
5494
  */
5495
5495
  action?: string;
5496
5496
  input?: {
@@ -6809,7 +6809,7 @@ type CreateAgentGenerationData = {
6809
6809
  };
6810
6810
  query?: {
6811
6811
  /**
6812
- * When omitted or `false` (default), the generation runs in the background and `202 Accepted` is returned immediately with a `generation_id` to poll. Pass `true` to block until the generation settles and receive the result. Mutually exclusive with `stream: true`. A `soat` tool call always waits.
6812
+ * When omitted or `false` (default), the generation runs in the background and `202 Accepted` is returned immediately with a `generation_id` to poll. Pass `true` to block until the generation settles and receive the result. Mutually exclusive with `stream: true`. A `builtin` tool call always waits.
6813
6813
  */
6814
6814
  wait?: boolean;
6815
6815
  };
@@ -7921,7 +7921,7 @@ type ListAuditEntriesData = {
7921
7921
  */
7922
7922
  resource_public_id?: string;
7923
7923
  /**
7924
- * SRN prefix match, e.g. `soat:{project}:secret:`
7924
+ * SRN prefix match, e.g. `srn:{project}:secret:`. Entries written before the `soat:` → `srn:` rename keep their original SRN (the log is append-only), so an `srn:` prefix also matches the equivalent `soat:` one and history stays reachable.
7925
7925
  */
7926
7926
  resource_srn?: string;
7927
7927
  /**
@@ -7994,7 +7994,7 @@ type ExportAuditEntriesData = {
7994
7994
  */
7995
7995
  resource_public_id?: string;
7996
7996
  /**
7997
- * SRN prefix match, e.g. `soat:{project}:secret:`
7997
+ * SRN prefix match, e.g. `srn:{project}:secret:`. Entries written before the `soat:` → `srn:` rename keep their original SRN (the log is append-only), so an `srn:` prefix also matches the equivalent `soat:` one and history stays reachable.
7998
7998
  */
7999
7999
  resource_srn?: string;
8000
8000
  /**
@@ -8549,7 +8549,7 @@ type GenerateConversationMessageData = {
8549
8549
  */
8550
8550
  stream?: boolean;
8551
8551
  /**
8552
- * Key-value pairs forwarded as `X-Soat-Context-<key>` headers on every `http`, `mcp` and `soat` tool call in this generation. The header name is the deployment's configured context prefix (`X-Soat-Context-` by default) plus the key verbatim — no character is re-cased and keys are never case-converted, so they round-trip exactly as sent. An invalid or colliding key is rejected with `400 INVALID_TOOL_CONTEXT_KEY`.
8552
+ * Key-value pairs forwarded as `X-Soat-Context-<key>` headers on every `http`, `mcp` and `builtin` tool call in this generation. The header name is the deployment's configured context prefix (`X-Soat-Context-` by default) plus the key verbatim — no character is re-cased and keys are never case-converted, so they round-trip exactly as sent. An invalid or colliding key is rejected with `400 INVALID_TOOL_CONTEXT_KEY`.
8553
8553
  */
8554
8554
  tool_context?: {
8555
8555
  [key: string]: string;
@@ -8560,7 +8560,7 @@ type GenerateConversationMessageData = {
8560
8560
  };
8561
8561
  query?: {
8562
8562
  /**
8563
- * When omitted or `false` (default), the generation runs in the background and `202 Accepted` is returned immediately. Pass `true` to block until the generation settles and receive the result. A `soat` tool call always waits.
8563
+ * When omitted or `false` (default), the generation runs in the background and `202 Accepted` is returned immediately. Pass `true` to block until the generation settles and receive the result. A `builtin` tool call always waits.
8564
8564
  */
8565
8565
  wait?: boolean;
8566
8566
  };
@@ -11719,7 +11719,7 @@ type EvaluateGuardrailData = {
11719
11719
  [key: string]: unknown;
11720
11720
  };
11721
11721
  /**
11722
- * Optional tool to resolve `soat.tool.*` against.
11722
+ * Optional tool to resolve `runtime.tool.*` against.
11723
11723
  */
11724
11724
  tool_id?: string;
11725
11725
  };
@@ -11815,7 +11815,7 @@ type CreateIngestionRuleData = {
11815
11815
  */
11816
11816
  agent_id?: string;
11817
11817
  /**
11818
- * Operation id, required for soat/mcp tool converters
11818
+ * Operation id, required for builtin/mcp tool converters
11819
11819
  */
11820
11820
  action?: string;
11821
11821
  /**
@@ -15109,7 +15109,7 @@ type CallToolErrors = {
15109
15109
  type CallToolError = CallToolErrors[keyof CallToolErrors];
15110
15110
  type CallToolResponses = {
15111
15111
  /**
15112
- * The raw output returned by the tool — any JSON value (object, array, string, number, boolean). `null` when the tool produced no output — a `soat` action answering `204 No Content`, for instance.
15112
+ * The raw output returned by the tool — any JSON value (object, array, string, number, boolean). `null` when the tool produced no output — a `builtin` action answering `204 No Content`, for instance.
15113
15113
  */
15114
15114
  200: unknown;
15115
15115
  };
@@ -17030,7 +17030,7 @@ declare class AuditLog {
17030
17030
  /**
17031
17031
  * List audit entries
17032
17032
  *
17033
- * Returns audit-log entries visible to the caller, newest first. All filters are optional and combine with AND. `resource_srn` is a prefix match (e.g. `soat:{project}:secret:` matches every secret action); every other filter is exact.
17033
+ * Returns audit-log entries visible to the caller, newest first. All filters are optional and combine with AND. `resource_srn` is a prefix match (e.g. `srn:{project}:secret:` matches every secret action); every other filter is exact.
17034
17034
  */
17035
17035
  static listAuditEntries<ThrowOnError extends boolean = false>(options?: Options<ListAuditEntriesData, ThrowOnError>): RequestResult<ListAuditEntriesResponses, ListAuditEntriesErrors, ThrowOnError>;
17036
17036
  /**
@@ -17567,7 +17567,7 @@ declare class Formations {
17567
17567
  *
17568
17568
  * Validates the template, creates the formation record, then provisions all declared resources in dependency order.
17569
17569
  *
17570
- * A **template-shape** error is refused with `400`. A **deploy** failure is not: the operation ran, so the formation is returned with `201` and `status: "failed"`, and `error` explains why (the resources created before the failure are rolled back). Read `status` — a `2xx` here means the deploy was attempted, not that it worked. The `soat` CLI exits non-zero on that body so `create-formation && …` does not lie.
17570
+ * A **template-shape** error is refused with `400`. A **deploy** failure is not: the operation ran, so the formation is returned with `201` and `status: "failed"`, and `error` explains why (the resources created before the failure are rolled back). Read `status` — a `2xx` here means the deploy was attempted, not that it worked. The `builtin` CLI exits non-zero on that body so `create-formation && …` does not lie.
17571
17571
  *
17572
17572
  */
17573
17573
  static createFormation<ThrowOnError extends boolean = false>(options: Options<CreateFormationData, ThrowOnError>): RequestResult<CreateFormationResponses, CreateFormationErrors, ThrowOnError>;
@@ -17593,7 +17593,7 @@ declare class Formations {
17593
17593
  *
17594
17594
  * Applies a new template to the formation. Resources are created, updated, or deleted to reconcile the current state with the desired state.
17595
17595
  *
17596
- * A **template-shape** error is refused with `400`. A **deploy** failure is not: the operation ran, so the formation is returned with `200` and `status: "failed"`, and `error` explains why. Read `status` — a `2xx` here means the deploy was attempted, not that it worked. The `soat` CLI exits non-zero on that body so `update-formation && …` does not lie.
17596
+ * A **template-shape** error is refused with `400`. A **deploy** failure is not: the operation ran, so the formation is returned with `200` and `status: "failed"`, and `error` explains why. Read `status` — a `2xx` here means the deploy was attempted, not that it worked. The `builtin` CLI exits non-zero on that body so `update-formation && …` does not lie.
17597
17597
  *
17598
17598
  */
17599
17599
  static updateFormation<ThrowOnError extends boolean = false>(options: Options<UpdateFormationData, ThrowOnError>): RequestResult<UpdateFormationResponses, UpdateFormationErrors, ThrowOnError>;
@@ -17662,7 +17662,7 @@ declare class Guardrails {
17662
17662
  /**
17663
17663
  * Create a guardrail
17664
17664
  *
17665
- * Creates a new guardrail in the project, archiving its document as version 1. The `document` is validated on write: `class` must be a literal (A/B/C/D) or a JSON Logic expression, and every variable it (and `guard`) reference must resolve to the `args.*` / `context.*` / `soat.*` namespaces — an out-of-catalog `soat.*` key is rejected with 400.
17665
+ * Creates a new guardrail in the project, archiving its document as version 1. The `document` is validated on write: `class` must be a literal (A/B/C/D) or a JSON Logic expression, and every variable it (and `guard`) reference must resolve to the `args.*` / `context.*` / `runtime.*` namespaces — an out-of-catalog `runtime.*` key is rejected with 400.
17666
17666
  *
17667
17667
  */
17668
17668
  static createGuardrail<ThrowOnError extends boolean = false>(options: Options<CreateGuardrailData, ThrowOnError>): RequestResult<CreateGuardrailResponses, CreateGuardrailErrors, ThrowOnError>;
@@ -17711,7 +17711,7 @@ declare class Guardrails {
17711
17711
  /**
17712
17712
  * Dry-run evaluate a guardrail
17713
17713
  *
17714
- * Runs the full evaluation pipeline — the `class` expression, the guard, the context tool per `context_mode`, live `soat.*` resolution — against caller-supplied `args` and `guardrail_context`, and returns the exact `guardrail_evaluation` record a real call would produce. Nothing executes, no approval item is filed, and no activity entry is written. This is the adoption path: preview a document's decisions against production-shaped calls before attaching it — or before editing a widely-attached one. Pass an optional `tool_id` to resolve `soat.tool.*`.
17714
+ * Runs the full evaluation pipeline — the `class` expression, the guard, the context tool per `context_mode`, live `runtime.*` resolution — against caller-supplied `args` and `guardrail_context`, and returns the exact `guardrail_evaluation` record a real call would produce. Nothing executes, no approval item is filed, and no activity entry is written. This is the adoption path: preview a document's decisions against production-shaped calls before attaching it — or before editing a widely-attached one. Pass an optional `tool_id` to resolve `runtime.tool.*`.
17715
17715
  *
17716
17716
  */
17717
17717
  static evaluateGuardrail<ThrowOnError extends boolean = false>(options: Options<EvaluateGuardrailData, ThrowOnError>): RequestResult<EvaluateGuardrailResponses, EvaluateGuardrailErrors, ThrowOnError>;
@@ -18273,8 +18273,8 @@ declare class Tools {
18273
18273
  /**
18274
18274
  * Call a tool
18275
18275
  *
18276
- * Directly invokes a tool and returns its output. Supported for `http`, `soat`, `mcp`, and `pipeline` tools. `client` tools cannot be invoked server-side and will return 422. A `pipeline` tool runs its declared steps in order and returns the mapped `output` (or the last step's output); `action` is ignored and `input` is the pipeline input.
18277
- * For `soat` and `mcp` tools the `action` field is required and identifies which action (SOAT) or tool name (MCP) to invoke. For `http` tools `action` is ignored. When a `soat` or `mcp` tool declares an `actions` allowlist, an action outside it is rejected with `400 VALIDATION_FAILED` ("not available on this tool") before any outbound request is made.
18276
+ * Directly invokes a tool and returns its output. Supported for `http`, `builtin`, `mcp`, and `pipeline` tools. `client` tools cannot be invoked server-side and will return 422. A `pipeline` tool runs its declared steps in order and returns the mapped `output` (or the last step's output); `action` is ignored and `input` is the pipeline input.
18277
+ * For `builtin` and `mcp` tools the `action` field is required and identifies which action (SOAT) or tool name (MCP) to invoke. For `http` tools `action` is ignored. When a `builtin` or `mcp` tool declares an `actions` allowlist, an action outside it is rejected with `400 VALIDATION_FAILED` ("not available on this tool") before any outbound request is made.
18278
18278
  * `preset_parameters` stored on the tool are merged with the caller-supplied `input` before execution; preset keys take lower precedence.
18279
18279
  *
18280
18280
  */
package/dist/index.d.mts CHANGED
@@ -862,7 +862,7 @@ type CreateAgentGenerationRequest = {
862
862
  */
863
863
  max_call_depth?: number;
864
864
  /**
865
- * Key-value pairs forwarded as `X-Soat-Context-<key>` headers on every `http`, `mcp` and `soat` tool call in this generation. The header name is the deployment's configured context prefix (`X-Soat-Context-` by default) plus the key verbatim — no character is re-cased. Keys are never case-converted — they round-trip exactly as sent. An invalid or colliding key is rejected with `400 INVALID_TOOL_CONTEXT_KEY`.
865
+ * Key-value pairs forwarded as `X-Soat-Context-<key>` headers on every `http`, `mcp` and `builtin` tool call in this generation. The header name is the deployment's configured context prefix (`X-Soat-Context-` by default) plus the key verbatim — no character is re-cased. Keys are never case-converted — they round-trip exactly as sent. An invalid or colliding key is rejected with `400 INVALID_TOOL_CONTEXT_KEY`.
866
866
  */
867
867
  tool_context?: {
868
868
  [key: string]: string;
@@ -906,7 +906,7 @@ type ToolOutputMessageContent = {
906
906
  */
907
907
  tool_id: string;
908
908
  /**
909
- * Optional action name for tools that require action selection (for example soat and mcp tools).
909
+ * Optional action name for tools that require action selection (for example builtin and mcp tools).
910
910
  */
911
911
  action?: string | null;
912
912
  /**
@@ -1205,7 +1205,7 @@ type ApprovalItem = {
1205
1205
  proposed_action?: {
1206
1206
  tool_id?: string;
1207
1207
  /**
1208
- * Resolved action name (the soat/mcp action) for `tool_call`-origin items — always present there, even for single-action tools. Omitted for `node`-origin items, whose downstream execution is wired by a separate `tool` node in the graph.
1208
+ * Resolved action name (the builtin/mcp action) for `tool_call`-origin items — always present there, even for single-action tools. Omitted for `node`-origin items, whose downstream execution is wired by a separate `tool` node in the graph.
1209
1209
  */
1210
1210
  action?: string;
1211
1211
  arguments?: {
@@ -1303,7 +1303,7 @@ type AuditEntry = {
1303
1303
  */
1304
1304
  action?: string;
1305
1305
  /**
1306
- * SRN the action targeted (type-level `soat:{project}:{type}:*` on creates)
1306
+ * SRN the action targeted (type-level `srn:{project}:{type}:*` on creates)
1307
1307
  */
1308
1308
  resource_srn?: string | null;
1309
1309
  /**
@@ -1733,11 +1733,11 @@ type ToolScorer = {
1733
1733
  */
1734
1734
  name: string;
1735
1735
  /**
1736
- * The tool that scores each item. It must belong to the eval's project and be server-callable (`http`, `mcp`, `soat`, or `pipeline` — a `client` tool pauses for a calling client an eval run does not have).
1736
+ * The tool that scores each item. It must belong to the eval's project and be server-callable (`http`, `mcp`, `builtin`, or `pipeline` — a `client` tool pauses for a calling client an eval run does not have).
1737
1737
  */
1738
1738
  tool_id: string;
1739
1739
  /**
1740
- * The operation to invoke; required when the tool type is `soat` or `mcp`.
1740
+ * The operation to invoke; required when the tool type is `builtin` or `mcp`.
1741
1741
  */
1742
1742
  action?: string | null;
1743
1743
  /**
@@ -2381,7 +2381,7 @@ type ToolResourceProperties = {
2381
2381
  */
2382
2382
  name: string;
2383
2383
  /**
2384
- * Tool type hint (e.g. http, mcp, soat, pipeline)
2384
+ * Tool type hint (e.g. http, mcp, builtin, pipeline)
2385
2385
  */
2386
2386
  type?: string | null;
2387
2387
  /**
@@ -2439,7 +2439,7 @@ type ToolResourceProperties = {
2439
2439
  } | null;
2440
2440
  } | null;
2441
2441
  /**
2442
- * Allowlist of actions the tool exposes. For `soat` tools: SOAT platform action names. For `mcp` tools: an optional allowlist of MCP tool names to scope the server surface (`null` exposes every tool).
2442
+ * Allowlist of actions the tool exposes. For `builtin` tools: SOAT platform action names. For `mcp` tools: an optional allowlist of MCP tool names to scope the server surface (`null` exposes every tool).
2443
2443
  */
2444
2444
  actions?: Array<string> | null;
2445
2445
  /**
@@ -2700,7 +2700,7 @@ type TriggerResourceProperties = {
2700
2700
  */
2701
2701
  target_id: string;
2702
2702
  /**
2703
- * Tool targets only — the action for soat/mcp tools
2703
+ * Tool targets only — the action for builtin/mcp tools
2704
2704
  */
2705
2705
  action?: string | null;
2706
2706
  /**
@@ -2911,7 +2911,7 @@ type IngestionRuleResourceProperties = {
2911
2911
  */
2912
2912
  agent_id?: string | null;
2913
2913
  /**
2914
- * Operation id, required for soat/mcp tool converters
2914
+ * Operation id, required for builtin/mcp tool converters
2915
2915
  */
2916
2916
  action?: string | null;
2917
2917
  /**
@@ -3588,7 +3588,7 @@ type GenerationTranscript = {
3588
3588
  content_redacted_by_principal_id?: string | null;
3589
3589
  };
3590
3590
  /**
3591
- * The action-class document. `class` maps a call to an action class; `guard` gates class-B autonomy. Both are single JSON Logic expressions over the `args.*` / `context.*` / `soat.*` namespaces.
3591
+ * The action-class document. `class` maps a call to an action class; `guard` gates class-B autonomy. Both are single JSON Logic expressions over the `args.*` / `context.*` / `runtime.*` namespaces.
3592
3592
  *
3593
3593
  */
3594
3594
  type GuardrailDocument = {
@@ -4532,7 +4532,7 @@ type StartRunRequest = {
4532
4532
  [key: string]: unknown;
4533
4533
  };
4534
4534
  /**
4535
- * Key-value pairs forwarded as `X-Soat-Context-<key>` headers on every `http`, `mcp` and `soat` tool call made by an agent node of this run — including the agents of any child run a `loop` or `sub_orchestration` node starts. The header name is `X-Soat-Context-` plus the key verbatim; no character is re-cased.
4535
+ * Key-value pairs forwarded as `X-Soat-Context-<key>` headers on every `http`, `mcp` and `builtin` tool call made by an agent node of this run — including the agents of any child run a `loop` or `sub_orchestration` node starts. The header name is `X-Soat-Context-` plus the key verbatim; no character is re-cased.
4536
4536
  *
4537
4537
  * The bag is stored on the run and re-read on every step, so it survives an `awaiting_input` pause, a `sleeping` wait, a background worker drive and a crash redrive. A key that is not a valid HTTP header name, or two keys that map to the same header, are rejected with `400 INVALID_TOOL_CONTEXT_KEY` and no run is created.
4538
4538
  *
@@ -4734,7 +4734,7 @@ type SessionRecord = {
4734
4734
  created_at?: Date;
4735
4735
  updated_at?: Date;
4736
4736
  /**
4737
- * Key-value pairs forwarded as `X-Soat-Context-<key>` headers on every `http`, `mcp` and `soat` tool call in this session. The header name is the deployment's configured context prefix (`X-Soat-Context-` by default) plus the key verbatim — no character is re-cased. Keys are never case-converted — they round-trip exactly as sent. A key that is not a valid HTTP header name, or two keys that map to the same header, are rejected with `400 INVALID_TOOL_CONTEXT_KEY`.
4737
+ * Key-value pairs forwarded as `X-Soat-Context-<key>` headers on every `http`, `mcp` and `builtin` tool call in this session. The header name is the deployment's configured context prefix (`X-Soat-Context-` by default) plus the key verbatim — no character is re-cased. Keys are never case-converted — they round-trip exactly as sent. A key that is not a valid HTTP header name, or two keys that map to the same header, are rejected with `400 INVALID_TOOL_CONTEXT_KEY`.
4738
4738
  */
4739
4739
  tool_context?: {
4740
4740
  [key: string]: string;
@@ -4811,7 +4811,7 @@ type CreateSessionRequest = {
4811
4811
  */
4812
4812
  auto_generate?: boolean;
4813
4813
  /**
4814
- * Key-value pairs forwarded as `X-Soat-Context-<key>` headers on every `http`, `mcp` and `soat` tool call in this session. The header name is the deployment's configured context prefix (`X-Soat-Context-` by default) plus the key verbatim — no character is re-cased. Keys are never case-converted — they round-trip exactly as sent. A key that is not a valid HTTP header name, or two keys that map to the same header, are rejected with `400 INVALID_TOOL_CONTEXT_KEY`.
4814
+ * Key-value pairs forwarded as `X-Soat-Context-<key>` headers on every `http`, `mcp` and `builtin` tool call in this session. The header name is the deployment's configured context prefix (`X-Soat-Context-` by default) plus the key verbatim — no character is re-cased. Keys are never case-converted — they round-trip exactly as sent. A key that is not a valid HTTP header name, or two keys that map to the same header, are rejected with `400 INVALID_TOOL_CONTEXT_KEY`.
4815
4815
  */
4816
4816
  tool_context?: {
4817
4817
  [key: string]: string;
@@ -4840,7 +4840,7 @@ type UpdateSessionRequest = {
4840
4840
  */
4841
4841
  auto_generate?: boolean;
4842
4842
  /**
4843
- * Key-value pairs forwarded as `X-Soat-Context-<key>` headers on every `http`, `mcp` and `soat` tool call in this session. The header name is the deployment's configured context prefix (`X-Soat-Context-` by default) plus the key verbatim — no character is re-cased. Keys are never case-converted — they round-trip exactly as sent. A key that is not a valid HTTP header name, or two keys that map to the same header, are rejected with `400 INVALID_TOOL_CONTEXT_KEY`.
4843
+ * Key-value pairs forwarded as `X-Soat-Context-<key>` headers on every `http`, `mcp` and `builtin` tool call in this session. The header name is the deployment's configured context prefix (`X-Soat-Context-` by default) plus the key verbatim — no character is re-cased. Keys are never case-converted — they round-trip exactly as sent. A key that is not a valid HTTP header name, or two keys that map to the same header, are rejected with `400 INVALID_TOOL_CONTEXT_KEY`.
4844
4844
  */
4845
4845
  tool_context?: {
4846
4846
  [key: string]: string;
@@ -4862,7 +4862,7 @@ type AddSessionMessageRequest = {
4862
4862
  */
4863
4863
  message: string;
4864
4864
  /**
4865
- * Key-value pairs forwarded as `X-Soat-Context-<key>` headers on every `http`, `mcp` and `soat` tool call in this generation. The header name is the deployment's configured context prefix (`X-Soat-Context-` by default) plus the key verbatim — no character is re-cased. Keys are never case-converted — they round-trip exactly as sent. An invalid or colliding key is rejected with `400 INVALID_TOOL_CONTEXT_KEY`.
4865
+ * Key-value pairs forwarded as `X-Soat-Context-<key>` headers on every `http`, `mcp` and `builtin` tool call in this generation. The header name is the deployment's configured context prefix (`X-Soat-Context-` by default) plus the key verbatim — no character is re-cased. Keys are never case-converted — they round-trip exactly as sent. An invalid or colliding key is rejected with `400 INVALID_TOOL_CONTEXT_KEY`.
4866
4866
  */
4867
4867
  tool_context?: {
4868
4868
  [key: string]: string;
@@ -4878,7 +4878,7 @@ type AddSessionMessageRequest = {
4878
4878
  */
4879
4879
  document_id: string;
4880
4880
  /**
4881
- * Key-value pairs forwarded as `X-Soat-Context-<key>` headers on every `http`, `mcp` and `soat` tool call in this generation. The header name is the deployment's configured context prefix (`X-Soat-Context-` by default) plus the key verbatim — no character is re-cased. Keys are never case-converted — they round-trip exactly as sent. An invalid or colliding key is rejected with `400 INVALID_TOOL_CONTEXT_KEY`.
4881
+ * Key-value pairs forwarded as `X-Soat-Context-<key>` headers on every `http`, `mcp` and `builtin` tool call in this generation. The header name is the deployment's configured context prefix (`X-Soat-Context-` by default) plus the key verbatim — no character is re-cased. Keys are never case-converted — they round-trip exactly as sent. An invalid or colliding key is rejected with `400 INVALID_TOOL_CONTEXT_KEY`.
4882
4882
  */
4883
4883
  tool_context?: {
4884
4884
  [key: string]: string;
@@ -4904,7 +4904,7 @@ type GenerateSessionRequest = {
4904
4904
  */
4905
4905
  model?: string;
4906
4906
  /**
4907
- * Key-value pairs forwarded as `X-Soat-Context-<key>` headers on every `http`, `mcp` and `soat` tool call in this generation. The header name is the deployment's configured context prefix (`X-Soat-Context-` by default) plus the key verbatim — no character is re-cased. Keys are never case-converted — they round-trip exactly as sent. An invalid or colliding key is rejected with `400 INVALID_TOOL_CONTEXT_KEY`.
4907
+ * Key-value pairs forwarded as `X-Soat-Context-<key>` headers on every `http`, `mcp` and `builtin` tool call in this generation. The header name is the deployment's configured context prefix (`X-Soat-Context-` by default) plus the key verbatim — no character is re-cased. Keys are never case-converted — they round-trip exactly as sent. An invalid or colliding key is rejected with `400 INVALID_TOOL_CONTEXT_KEY`.
4908
4908
  */
4909
4909
  tool_context?: {
4910
4910
  [key: string]: string;
@@ -5056,7 +5056,7 @@ type CreateTaskRequest = {
5056
5056
  */
5057
5057
  state?: string;
5058
5058
  /**
5059
- * Key-value pairs forwarded as `X-Soat-Context-<key>` headers on every `http`, `mcp` and `soat` tool call made by this task's automation dispatches — the agent generations a state's `on_enter` starts, and the agent nodes of any orchestration run it starts. The header name is `X-Soat-Context-` plus the key verbatim; no character is re-cased.
5059
+ * Key-value pairs forwarded as `X-Soat-Context-<key>` headers on every `http`, `mcp` and `builtin` tool call made by this task's automation dispatches — the agent generations a state's `on_enter` starts, and the agent nodes of any orchestration run it starts. The header name is `X-Soat-Context-` plus the key verbatim; no character is re-cased.
5060
5060
  * Creation is the task's first move, so this is the bag the entry state's `on_enter` runs with. Each transition may replace it (see `TransitionTaskRequest.tool_context`).
5061
5061
  * The reserved identity keys (`sessionId`, `actorId`, `actorExternalId`) are stripped in any casing and re-derived server-side, so a task-dispatched generation cannot forge them. A key outside the HTTP header-name grammar is rejected with `INVALID_TOOL_CONTEXT_KEY` (400).
5062
5062
  * Write-only: the stored bag is never returned by any task read, and it is cleared when the task reaches a terminal state.
@@ -5104,7 +5104,7 @@ type Tool = {
5104
5104
  /**
5105
5105
  * Tool type
5106
5106
  */
5107
- type?: 'http' | 'client' | 'mcp' | 'soat' | 'pipeline';
5107
+ type?: 'http' | 'client' | 'mcp' | 'builtin' | 'pipeline';
5108
5108
  /**
5109
5109
  * What the tool does (sent to the model)
5110
5110
  */
@@ -5138,7 +5138,7 @@ type Tool = {
5138
5138
  [key: string]: unknown;
5139
5139
  } | null;
5140
5140
  /**
5141
- * Allowlist of actions to expose. For `soat` tools: SOAT platform action names (required). For `mcp` tools: an optional allowlist of MCP tool names — when set, only those tools are exposed to the model and callable via `/call`; when `null`, the entire MCP server surface is exposed. Ignored for other tool types.
5141
+ * Allowlist of actions to expose. For `builtin` tools: SOAT platform action names (required). For `mcp` tools: an optional allowlist of MCP tool names — when set, only those tools are exposed to the model and callable via `/call`; when `null`, the entire MCP server surface is exposed. Ignored for other tool types.
5142
5142
  */
5143
5143
  actions?: Array<string> | null;
5144
5144
  /**
@@ -5150,7 +5150,7 @@ type Tool = {
5150
5150
  */
5151
5151
  context_keys?: Array<string> | null;
5152
5152
  /**
5153
- * Fixed parameters merged into every soat tool call. Keys matching fields in the action's input schema are removed from the schema shown to the model and injected automatically at execution time.
5153
+ * Fixed parameters merged into every builtin tool call. Keys matching fields in the action's input schema are removed from the schema shown to the model and injected automatically at execution time.
5154
5154
  */
5155
5155
  preset_parameters?: {
5156
5156
  [key: string]: unknown;
@@ -5162,7 +5162,7 @@ type Tool = {
5162
5162
  [key: string]: unknown;
5163
5163
  } | null;
5164
5164
  /**
5165
- * Universal JSON Logic mapping applied to the tool's raw result, for every tool type (`http`, `mcp`, `soat`, `pipeline`, `client`). Evaluated over `{ output: <raw result>, input: <merged input> }`, so `{ "var": "output.text" }` extracts a bare scalar field instead of requiring a wrapping `pipeline` tool, and `{ "var": "input.title" }` echoes back a field of the request that produced the response. For `pipeline` tools this runs *after* the pipeline's own `output` mapping, over that mapping's result.
5165
+ * Universal JSON Logic mapping applied to the tool's raw result, for every tool type (`http`, `mcp`, `builtin`, `pipeline`, `client`). Evaluated over `{ output: <raw result>, input: <merged input> }`, so `{ "var": "output.text" }` extracts a bare scalar field instead of requiring a wrapping `pipeline` tool, and `{ "var": "input.title" }` echoes back a field of the request that produced the response. For `pipeline` tools this runs *after* the pipeline's own `output` mapping, over that mapping's result.
5166
5166
  */
5167
5167
  output_mapping?: {
5168
5168
  [key: string]: unknown;
@@ -5186,7 +5186,7 @@ type CreateToolRequest = {
5186
5186
  /**
5187
5187
  * Tool type (default http)
5188
5188
  */
5189
- type?: 'http' | 'client' | 'mcp' | 'soat' | 'pipeline';
5189
+ type?: 'http' | 'client' | 'mcp' | 'builtin' | 'pipeline';
5190
5190
  /**
5191
5191
  * What the tool does
5192
5192
  */
@@ -5220,7 +5220,7 @@ type CreateToolRequest = {
5220
5220
  [key: string]: unknown;
5221
5221
  };
5222
5222
  /**
5223
- * Allowlist of actions. For `soat` tools: SOAT platform action names (required). For `mcp` tools: an optional allowlist of MCP tool names to scope the server surface — omit or set `null` to expose every tool the MCP server offers. Ignored for other tool types.
5223
+ * Allowlist of actions. For `builtin` tools: SOAT platform action names (required). For `mcp` tools: an optional allowlist of MCP tool names to scope the server surface — omit or set `null` to expose every tool the MCP server offers. Ignored for other tool types.
5224
5224
  */
5225
5225
  actions?: Array<string>;
5226
5226
  /**
@@ -5232,7 +5232,7 @@ type CreateToolRequest = {
5232
5232
  */
5233
5233
  context_keys?: Array<string> | null;
5234
5234
  /**
5235
- * Fixed parameters merged into every soat tool call. Keys matching fields in the action's input schema are removed from the schema shown to the model and injected automatically at execution time.
5235
+ * Fixed parameters merged into every builtin tool call. Keys matching fields in the action's input schema are removed from the schema shown to the model and injected automatically at execution time.
5236
5236
  */
5237
5237
  preset_parameters?: {
5238
5238
  [key: string]: unknown;
@@ -5256,7 +5256,7 @@ type CreateToolRequest = {
5256
5256
  };
5257
5257
  type UpdateToolRequest = {
5258
5258
  name?: string;
5259
- type?: 'http' | 'client' | 'mcp' | 'soat' | 'pipeline';
5259
+ type?: 'http' | 'client' | 'mcp' | 'builtin' | 'pipeline';
5260
5260
  description?: string | null;
5261
5261
  parameters?: {
5262
5262
  [key: string]: unknown;
@@ -5284,7 +5284,7 @@ type UpdateToolRequest = {
5284
5284
  [key: string]: unknown;
5285
5285
  } | null;
5286
5286
  /**
5287
- * Allowlist of actions. For `soat` tools: SOAT platform action names. For `mcp` tools: an optional allowlist of MCP tool names to scope the server surface (`null` exposes every tool). Ignored for other tool types.
5287
+ * Allowlist of actions. For `builtin` tools: SOAT platform action names. For `mcp` tools: an optional allowlist of MCP tool names to scope the server surface (`null` exposes every tool). Ignored for other tool types.
5288
5288
  */
5289
5289
  actions?: Array<string> | null;
5290
5290
  /**
@@ -5296,7 +5296,7 @@ type UpdateToolRequest = {
5296
5296
  */
5297
5297
  context_keys?: Array<string> | null;
5298
5298
  /**
5299
- * Fixed parameters merged into every soat tool call. Keys matching fields in the action's input schema are removed from the schema shown to the model and injected automatically at execution time.
5299
+ * Fixed parameters merged into every builtin tool call. Keys matching fields in the action's input schema are removed from the schema shown to the model and injected automatically at execution time.
5300
5300
  */
5301
5301
  preset_parameters?: {
5302
5302
  [key: string]: unknown;
@@ -5320,7 +5320,7 @@ type UpdateToolRequest = {
5320
5320
  };
5321
5321
  type CallToolRequest = {
5322
5322
  /**
5323
- * For `soat` tools: the action name (must be in the tool's `actions` list). For `mcp` tools: the MCP tool name to invoke (must be in the tool's `actions` allowlist when one is set, and must not be in its `denied_actions` denylist). Ignored for `http` tools.
5323
+ * For `builtin` tools: the action name (must be in the tool's `actions` list). For `mcp` tools: the MCP tool name to invoke (must be in the tool's `actions` allowlist when one is set, and must not be in its `denied_actions` denylist). Ignored for `http` tools.
5324
5324
  *
5325
5325
  */
5326
5326
  action?: string;
@@ -5448,7 +5448,7 @@ type Trigger = {
5448
5448
  */
5449
5449
  target_id?: string;
5450
5450
  /**
5451
- * Tool targets only — the action for soat/mcp tools
5451
+ * Tool targets only — the action for builtin/mcp tools
5452
5452
  */
5453
5453
  action?: string | null;
5454
5454
  /**
@@ -5490,7 +5490,7 @@ type CreateTriggerRequest = {
5490
5490
  target_type: 'orchestration' | 'agent' | 'tool' | 'eval';
5491
5491
  target_id: string;
5492
5492
  /**
5493
- * Tool targets only — the action for soat/mcp tools
5493
+ * Tool targets only — the action for builtin/mcp tools
5494
5494
  */
5495
5495
  action?: string;
5496
5496
  input?: {
@@ -6809,7 +6809,7 @@ type CreateAgentGenerationData = {
6809
6809
  };
6810
6810
  query?: {
6811
6811
  /**
6812
- * When omitted or `false` (default), the generation runs in the background and `202 Accepted` is returned immediately with a `generation_id` to poll. Pass `true` to block until the generation settles and receive the result. Mutually exclusive with `stream: true`. A `soat` tool call always waits.
6812
+ * When omitted or `false` (default), the generation runs in the background and `202 Accepted` is returned immediately with a `generation_id` to poll. Pass `true` to block until the generation settles and receive the result. Mutually exclusive with `stream: true`. A `builtin` tool call always waits.
6813
6813
  */
6814
6814
  wait?: boolean;
6815
6815
  };
@@ -7921,7 +7921,7 @@ type ListAuditEntriesData = {
7921
7921
  */
7922
7922
  resource_public_id?: string;
7923
7923
  /**
7924
- * SRN prefix match, e.g. `soat:{project}:secret:`
7924
+ * SRN prefix match, e.g. `srn:{project}:secret:`. Entries written before the `soat:` → `srn:` rename keep their original SRN (the log is append-only), so an `srn:` prefix also matches the equivalent `soat:` one and history stays reachable.
7925
7925
  */
7926
7926
  resource_srn?: string;
7927
7927
  /**
@@ -7994,7 +7994,7 @@ type ExportAuditEntriesData = {
7994
7994
  */
7995
7995
  resource_public_id?: string;
7996
7996
  /**
7997
- * SRN prefix match, e.g. `soat:{project}:secret:`
7997
+ * SRN prefix match, e.g. `srn:{project}:secret:`. Entries written before the `soat:` → `srn:` rename keep their original SRN (the log is append-only), so an `srn:` prefix also matches the equivalent `soat:` one and history stays reachable.
7998
7998
  */
7999
7999
  resource_srn?: string;
8000
8000
  /**
@@ -8549,7 +8549,7 @@ type GenerateConversationMessageData = {
8549
8549
  */
8550
8550
  stream?: boolean;
8551
8551
  /**
8552
- * Key-value pairs forwarded as `X-Soat-Context-<key>` headers on every `http`, `mcp` and `soat` tool call in this generation. The header name is the deployment's configured context prefix (`X-Soat-Context-` by default) plus the key verbatim — no character is re-cased and keys are never case-converted, so they round-trip exactly as sent. An invalid or colliding key is rejected with `400 INVALID_TOOL_CONTEXT_KEY`.
8552
+ * Key-value pairs forwarded as `X-Soat-Context-<key>` headers on every `http`, `mcp` and `builtin` tool call in this generation. The header name is the deployment's configured context prefix (`X-Soat-Context-` by default) plus the key verbatim — no character is re-cased and keys are never case-converted, so they round-trip exactly as sent. An invalid or colliding key is rejected with `400 INVALID_TOOL_CONTEXT_KEY`.
8553
8553
  */
8554
8554
  tool_context?: {
8555
8555
  [key: string]: string;
@@ -8560,7 +8560,7 @@ type GenerateConversationMessageData = {
8560
8560
  };
8561
8561
  query?: {
8562
8562
  /**
8563
- * When omitted or `false` (default), the generation runs in the background and `202 Accepted` is returned immediately. Pass `true` to block until the generation settles and receive the result. A `soat` tool call always waits.
8563
+ * When omitted or `false` (default), the generation runs in the background and `202 Accepted` is returned immediately. Pass `true` to block until the generation settles and receive the result. A `builtin` tool call always waits.
8564
8564
  */
8565
8565
  wait?: boolean;
8566
8566
  };
@@ -11719,7 +11719,7 @@ type EvaluateGuardrailData = {
11719
11719
  [key: string]: unknown;
11720
11720
  };
11721
11721
  /**
11722
- * Optional tool to resolve `soat.tool.*` against.
11722
+ * Optional tool to resolve `runtime.tool.*` against.
11723
11723
  */
11724
11724
  tool_id?: string;
11725
11725
  };
@@ -11815,7 +11815,7 @@ type CreateIngestionRuleData = {
11815
11815
  */
11816
11816
  agent_id?: string;
11817
11817
  /**
11818
- * Operation id, required for soat/mcp tool converters
11818
+ * Operation id, required for builtin/mcp tool converters
11819
11819
  */
11820
11820
  action?: string;
11821
11821
  /**
@@ -15109,7 +15109,7 @@ type CallToolErrors = {
15109
15109
  type CallToolError = CallToolErrors[keyof CallToolErrors];
15110
15110
  type CallToolResponses = {
15111
15111
  /**
15112
- * The raw output returned by the tool — any JSON value (object, array, string, number, boolean). `null` when the tool produced no output — a `soat` action answering `204 No Content`, for instance.
15112
+ * The raw output returned by the tool — any JSON value (object, array, string, number, boolean). `null` when the tool produced no output — a `builtin` action answering `204 No Content`, for instance.
15113
15113
  */
15114
15114
  200: unknown;
15115
15115
  };
@@ -17030,7 +17030,7 @@ declare class AuditLog {
17030
17030
  /**
17031
17031
  * List audit entries
17032
17032
  *
17033
- * Returns audit-log entries visible to the caller, newest first. All filters are optional and combine with AND. `resource_srn` is a prefix match (e.g. `soat:{project}:secret:` matches every secret action); every other filter is exact.
17033
+ * Returns audit-log entries visible to the caller, newest first. All filters are optional and combine with AND. `resource_srn` is a prefix match (e.g. `srn:{project}:secret:` matches every secret action); every other filter is exact.
17034
17034
  */
17035
17035
  static listAuditEntries<ThrowOnError extends boolean = false>(options?: Options<ListAuditEntriesData, ThrowOnError>): RequestResult<ListAuditEntriesResponses, ListAuditEntriesErrors, ThrowOnError>;
17036
17036
  /**
@@ -17567,7 +17567,7 @@ declare class Formations {
17567
17567
  *
17568
17568
  * Validates the template, creates the formation record, then provisions all declared resources in dependency order.
17569
17569
  *
17570
- * A **template-shape** error is refused with `400`. A **deploy** failure is not: the operation ran, so the formation is returned with `201` and `status: "failed"`, and `error` explains why (the resources created before the failure are rolled back). Read `status` — a `2xx` here means the deploy was attempted, not that it worked. The `soat` CLI exits non-zero on that body so `create-formation && …` does not lie.
17570
+ * A **template-shape** error is refused with `400`. A **deploy** failure is not: the operation ran, so the formation is returned with `201` and `status: "failed"`, and `error` explains why (the resources created before the failure are rolled back). Read `status` — a `2xx` here means the deploy was attempted, not that it worked. The `builtin` CLI exits non-zero on that body so `create-formation && …` does not lie.
17571
17571
  *
17572
17572
  */
17573
17573
  static createFormation<ThrowOnError extends boolean = false>(options: Options<CreateFormationData, ThrowOnError>): RequestResult<CreateFormationResponses, CreateFormationErrors, ThrowOnError>;
@@ -17593,7 +17593,7 @@ declare class Formations {
17593
17593
  *
17594
17594
  * Applies a new template to the formation. Resources are created, updated, or deleted to reconcile the current state with the desired state.
17595
17595
  *
17596
- * A **template-shape** error is refused with `400`. A **deploy** failure is not: the operation ran, so the formation is returned with `200` and `status: "failed"`, and `error` explains why. Read `status` — a `2xx` here means the deploy was attempted, not that it worked. The `soat` CLI exits non-zero on that body so `update-formation && …` does not lie.
17596
+ * A **template-shape** error is refused with `400`. A **deploy** failure is not: the operation ran, so the formation is returned with `200` and `status: "failed"`, and `error` explains why. Read `status` — a `2xx` here means the deploy was attempted, not that it worked. The `builtin` CLI exits non-zero on that body so `update-formation && …` does not lie.
17597
17597
  *
17598
17598
  */
17599
17599
  static updateFormation<ThrowOnError extends boolean = false>(options: Options<UpdateFormationData, ThrowOnError>): RequestResult<UpdateFormationResponses, UpdateFormationErrors, ThrowOnError>;
@@ -17662,7 +17662,7 @@ declare class Guardrails {
17662
17662
  /**
17663
17663
  * Create a guardrail
17664
17664
  *
17665
- * Creates a new guardrail in the project, archiving its document as version 1. The `document` is validated on write: `class` must be a literal (A/B/C/D) or a JSON Logic expression, and every variable it (and `guard`) reference must resolve to the `args.*` / `context.*` / `soat.*` namespaces — an out-of-catalog `soat.*` key is rejected with 400.
17665
+ * Creates a new guardrail in the project, archiving its document as version 1. The `document` is validated on write: `class` must be a literal (A/B/C/D) or a JSON Logic expression, and every variable it (and `guard`) reference must resolve to the `args.*` / `context.*` / `runtime.*` namespaces — an out-of-catalog `runtime.*` key is rejected with 400.
17666
17666
  *
17667
17667
  */
17668
17668
  static createGuardrail<ThrowOnError extends boolean = false>(options: Options<CreateGuardrailData, ThrowOnError>): RequestResult<CreateGuardrailResponses, CreateGuardrailErrors, ThrowOnError>;
@@ -17711,7 +17711,7 @@ declare class Guardrails {
17711
17711
  /**
17712
17712
  * Dry-run evaluate a guardrail
17713
17713
  *
17714
- * Runs the full evaluation pipeline — the `class` expression, the guard, the context tool per `context_mode`, live `soat.*` resolution — against caller-supplied `args` and `guardrail_context`, and returns the exact `guardrail_evaluation` record a real call would produce. Nothing executes, no approval item is filed, and no activity entry is written. This is the adoption path: preview a document's decisions against production-shaped calls before attaching it — or before editing a widely-attached one. Pass an optional `tool_id` to resolve `soat.tool.*`.
17714
+ * Runs the full evaluation pipeline — the `class` expression, the guard, the context tool per `context_mode`, live `runtime.*` resolution — against caller-supplied `args` and `guardrail_context`, and returns the exact `guardrail_evaluation` record a real call would produce. Nothing executes, no approval item is filed, and no activity entry is written. This is the adoption path: preview a document's decisions against production-shaped calls before attaching it — or before editing a widely-attached one. Pass an optional `tool_id` to resolve `runtime.tool.*`.
17715
17715
  *
17716
17716
  */
17717
17717
  static evaluateGuardrail<ThrowOnError extends boolean = false>(options: Options<EvaluateGuardrailData, ThrowOnError>): RequestResult<EvaluateGuardrailResponses, EvaluateGuardrailErrors, ThrowOnError>;
@@ -18273,8 +18273,8 @@ declare class Tools {
18273
18273
  /**
18274
18274
  * Call a tool
18275
18275
  *
18276
- * Directly invokes a tool and returns its output. Supported for `http`, `soat`, `mcp`, and `pipeline` tools. `client` tools cannot be invoked server-side and will return 422. A `pipeline` tool runs its declared steps in order and returns the mapped `output` (or the last step's output); `action` is ignored and `input` is the pipeline input.
18277
- * For `soat` and `mcp` tools the `action` field is required and identifies which action (SOAT) or tool name (MCP) to invoke. For `http` tools `action` is ignored. When a `soat` or `mcp` tool declares an `actions` allowlist, an action outside it is rejected with `400 VALIDATION_FAILED` ("not available on this tool") before any outbound request is made.
18276
+ * Directly invokes a tool and returns its output. Supported for `http`, `builtin`, `mcp`, and `pipeline` tools. `client` tools cannot be invoked server-side and will return 422. A `pipeline` tool runs its declared steps in order and returns the mapped `output` (or the last step's output); `action` is ignored and `input` is the pipeline input.
18277
+ * For `builtin` and `mcp` tools the `action` field is required and identifies which action (SOAT) or tool name (MCP) to invoke. For `http` tools `action` is ignored. When a `builtin` or `mcp` tool declares an `actions` allowlist, an action outside it is rejected with `400 VALIDATION_FAILED` ("not available on this tool") before any outbound request is made.
18278
18278
  * `preset_parameters` stored on the tool are merged with the caller-supplied `input` before execution; preset keys take lower precedence.
18279
18279
  *
18280
18280
  */
package/dist/index.mjs CHANGED
@@ -1197,7 +1197,7 @@ var AuditLog = class {
1197
1197
  /**
1198
1198
  * List audit entries
1199
1199
  *
1200
- * Returns audit-log entries visible to the caller, newest first. All filters are optional and combine with AND. `resource_srn` is a prefix match (e.g. `soat:{project}:secret:` matches every secret action); every other filter is exact.
1200
+ * Returns audit-log entries visible to the caller, newest first. All filters are optional and combine with AND. `resource_srn` is a prefix match (e.g. `srn:{project}:secret:` matches every secret action); every other filter is exact.
1201
1201
  */
1202
1202
  static listAuditEntries(options) {
1203
1203
  return (options?.client ?? client).get({
@@ -2245,7 +2245,7 @@ var Formations = class {
2245
2245
  *
2246
2246
  * Validates the template, creates the formation record, then provisions all declared resources in dependency order.
2247
2247
  *
2248
- * A **template-shape** error is refused with `400`. A **deploy** failure is not: the operation ran, so the formation is returned with `201` and `status: "failed"`, and `error` explains why (the resources created before the failure are rolled back). Read `status` — a `2xx` here means the deploy was attempted, not that it worked. The `soat` CLI exits non-zero on that body so `create-formation && …` does not lie.
2248
+ * A **template-shape** error is refused with `400`. A **deploy** failure is not: the operation ran, so the formation is returned with `201` and `status: "failed"`, and `error` explains why (the resources created before the failure are rolled back). Read `status` — a `2xx` here means the deploy was attempted, not that it worked. The `builtin` CLI exits non-zero on that body so `create-formation && …` does not lie.
2249
2249
  *
2250
2250
  */
2251
2251
  static createFormation(options) {
@@ -2290,7 +2290,7 @@ var Formations = class {
2290
2290
  *
2291
2291
  * Applies a new template to the formation. Resources are created, updated, or deleted to reconcile the current state with the desired state.
2292
2292
  *
2293
- * A **template-shape** error is refused with `400`. A **deploy** failure is not: the operation ran, so the formation is returned with `200` and `status: "failed"`, and `error` explains why. Read `status` — a `2xx` here means the deploy was attempted, not that it worked. The `soat` CLI exits non-zero on that body so `update-formation && …` does not lie.
2293
+ * A **template-shape** error is refused with `400`. A **deploy** failure is not: the operation ran, so the formation is returned with `200` and `status: "failed"`, and `error` explains why. Read `status` — a `2xx` here means the deploy was attempted, not that it worked. The `builtin` CLI exits non-zero on that body so `update-formation && …` does not lie.
2294
2294
  *
2295
2295
  */
2296
2296
  static updateFormation(options) {
@@ -2407,7 +2407,7 @@ var Guardrails = class {
2407
2407
  /**
2408
2408
  * Create a guardrail
2409
2409
  *
2410
- * Creates a new guardrail in the project, archiving its document as version 1. The `document` is validated on write: `class` must be a literal (A/B/C/D) or a JSON Logic expression, and every variable it (and `guard`) reference must resolve to the `args.*` / `context.*` / `soat.*` namespaces — an out-of-catalog `soat.*` key is rejected with 400.
2410
+ * Creates a new guardrail in the project, archiving its document as version 1. The `document` is validated on write: `class` must be a literal (A/B/C/D) or a JSON Logic expression, and every variable it (and `guard`) reference must resolve to the `args.*` / `context.*` / `runtime.*` namespaces — an out-of-catalog `runtime.*` key is rejected with 400.
2411
2411
  *
2412
2412
  */
2413
2413
  static createGuardrail(options) {
@@ -2503,7 +2503,7 @@ var Guardrails = class {
2503
2503
  /**
2504
2504
  * Dry-run evaluate a guardrail
2505
2505
  *
2506
- * Runs the full evaluation pipeline — the `class` expression, the guard, the context tool per `context_mode`, live `soat.*` resolution — against caller-supplied `args` and `guardrail_context`, and returns the exact `guardrail_evaluation` record a real call would produce. Nothing executes, no approval item is filed, and no activity entry is written. This is the adoption path: preview a document's decisions against production-shaped calls before attaching it — or before editing a widely-attached one. Pass an optional `tool_id` to resolve `soat.tool.*`.
2506
+ * Runs the full evaluation pipeline — the `class` expression, the guard, the context tool per `context_mode`, live `runtime.*` resolution — against caller-supplied `args` and `guardrail_context`, and returns the exact `guardrail_evaluation` record a real call would produce. Nothing executes, no approval item is filed, and no activity entry is written. This is the adoption path: preview a document's decisions against production-shaped calls before attaching it — or before editing a widely-attached one. Pass an optional `tool_id` to resolve `runtime.tool.*`.
2507
2507
  *
2508
2508
  */
2509
2509
  static evaluateGuardrail(options) {
@@ -3650,8 +3650,8 @@ var Tools = class {
3650
3650
  /**
3651
3651
  * Call a tool
3652
3652
  *
3653
- * Directly invokes a tool and returns its output. Supported for `http`, `soat`, `mcp`, and `pipeline` tools. `client` tools cannot be invoked server-side and will return 422. A `pipeline` tool runs its declared steps in order and returns the mapped `output` (or the last step's output); `action` is ignored and `input` is the pipeline input.
3654
- * For `soat` and `mcp` tools the `action` field is required and identifies which action (SOAT) or tool name (MCP) to invoke. For `http` tools `action` is ignored. When a `soat` or `mcp` tool declares an `actions` allowlist, an action outside it is rejected with `400 VALIDATION_FAILED` ("not available on this tool") before any outbound request is made.
3653
+ * Directly invokes a tool and returns its output. Supported for `http`, `builtin`, `mcp`, and `pipeline` tools. `client` tools cannot be invoked server-side and will return 422. A `pipeline` tool runs its declared steps in order and returns the mapped `output` (or the last step's output); `action` is ignored and `input` is the pipeline input.
3654
+ * For `builtin` and `mcp` tools the `action` field is required and identifies which action (SOAT) or tool name (MCP) to invoke. For `http` tools `action` is ignored. When a `builtin` or `mcp` tool declares an `actions` allowlist, an action outside it is rejected with `400 VALIDATION_FAILED` ("not available on this tool") before any outbound request is made.
3655
3655
  * `preset_parameters` stored on the tool are merged with the caller-supplied `input` before execution; preset keys take lower precedence.
3656
3656
  *
3657
3657
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@soat/sdk",
3
- "version": "0.26.0",
3
+ "version": "0.27.0",
4
4
  "description": "TypeScript SDK for the SOAT API",
5
5
  "license": "Apache-2.0",
6
6
  "type": "module",