@standardagents/spec 0.45.2 → 0.45.4

package/dist/index.d.ts

@@ -105,11 +105,11 @@ declare global {
          */
         type Tools = keyof ToolRegistry extends never ? string : keyof ToolRegistry;
         /**
-         * Provider-executed tool reference stored by AgentBuilder prompts.
+         * Provider-executed tool reference stored by Standard Agents Builder prompts.
          */
         type ProviderCallable = `provider:${string}`;
         /**
-         * MCP tool reference stored by AgentBuilder prompts.
+         * MCP tool reference stored by Standard Agents Builder prompts.
          */
         type McpCallable = `mcp:${string}`;
         /**
@@ -2151,7 +2151,11 @@ interface ThreadMessageChunkEvent {
     type: 'message_chunk';
     /** The assistant message these fragments belong to. */
     message_id: string;
-    /** Message depth: 0 = top-level thread, 1+ = subagent. */
+    /**
+     * Depth of the message identified by `message_id`: 0 = top-level thread,
+     * 1+ = nested (sub-prompt). A connection receives the frame only when its
+     * `depth` is at least this value.
+     */
     depth: number;
     /** The next fragment of visible content. */
     chunk: string;
@@ -2174,7 +2178,11 @@ interface ThreadReasoningChunkEvent {
     type: 'reasoning_chunk';
     /** The assistant message this reasoning accompanies. */
     message_id: string;
-    /** Message depth: 0 = top-level thread, 1+ = subagent. */
+    /**
+     * Depth of the message identified by `message_id`: 0 = top-level thread,
+     * 1+ = nested (sub-prompt). An opted-in connection receives the frame only
+     * when its `depth` is at least this value.
+     */
     depth: number;
     /** The next fragment of internal reasoning. */
     chunk: string;
@@ -2602,7 +2610,8 @@ interface ExecutionState {
      * Abort signal for cancellation.
      *
      * Can be used to abort fetch requests or other async operations
-     * when the execution is cancelled.
+     * when the execution is cancelled. The signal is also aborted when the
+     * thread is deleted while the execution is in flight.
      */
     readonly abortSignal: AbortSignal;
     /**
@@ -2910,7 +2919,7 @@ interface ThreadState {
      * 2. Agent definition
      * 3. Prompt definition
      * 4. User account
-     * 5. AgentBuilder instance
+     * 5. Standard Agents Builder instance
      *
      * @throws If the variable is not defined in any source
      */
@@ -2934,8 +2943,8 @@ interface ThreadState {
      * Resolve the display/redaction type for an environment value.
      *
      * Resolution follows the same order as `env()`:
-     * thread, agent definition, prompt definition, user account, AgentBuilder instance.
-     * User-account and AgentBuilder-instance env stores may persist per-key
+     * thread, agent definition, prompt definition, user account, Standard Agents Builder instance.
+     * User-account and Standard Agents Builder-instance env stores may persist per-key
      * `text` / `secret` metadata; agent/prompt defaults remain `secret` unless
      * overridden by thread state.
      *
@@ -3094,7 +3103,8 @@ interface ThreadState {
      * for real-time updates, progress notifications, or custom data.
      *
      * @param event - Event name
-     * @param data - Event data (must be JSON-serializable)
+     * @param data - Event data (must be JSON-serializable). An `undefined`
+     *   value reaches clients as `data: null` on the event frame.
      */
     emit(event: string, data: unknown): void;
     /**
@@ -4259,9 +4269,11 @@ interface ReasoningConfig {
      */
     exclude?: boolean;
     /**
-     * Include reasoning content in the message history for multi-turn context.
-     * When true, reasoning is preserved and visible to subsequent turns.
-     * @default false
+     * Supply the persisted reasoning of earlier assistant messages on later requests.
+     * When true or unset, the runtime sends the stored reasoning text and
+     * provider-specific reasoning data back to the model with each earlier message.
+     * When false, the runtime does not send it. The reasoning stays in the message record.
+     * @default true
      */
     include?: boolean;
 }
@@ -4329,7 +4341,7 @@ interface PromptDefinition<N extends string = string, S extends ToolArgs = ToolA
      * Tool calling strategy for the LLM.
      *
      * - `auto`: Model decides when to call tools (default)
-     * - `none`: Disable tool calling entirely
+     * - `none`: The model must not call tools (definitions may still be sent)
      * - `required`: Force the model to call at least one tool
      *
      * @default 'auto'
@@ -4377,7 +4389,7 @@ interface PromptDefinition<N extends string = string, S extends ToolArgs = ToolA
     tools?: (StandardAgentSpec.Callables | SubpromptConfig | PromptToolConfig)[];
     /**
      * Environment values provided by this prompt.
-     * Prompt values override user-account and AgentBuilder-instance defaults.
+     * Prompt values override user-account and Standard Agents Builder-instance defaults.
      * Agent and thread values override prompt values.
      */
     env?: Record<string, string>;
@@ -4526,8 +4538,8 @@ declare function definePrompt<N extends string, S extends ToolArgs = never>(opti
  */
 interface SubagentRelationship<Agent extends string = StandardAgentSpec.Agents> {
     /**
-     * Which agent definition to instantiate. Must reference an agent with
-     * `exposeAsTool: true`.
+     * Which agent definition to instantiate. Any agent is eligible;
+     * `exposeAsTool: true` marks an agent as designed for composition.
      */
     readonly agent: Agent;
     /**
@@ -4996,6 +5008,11 @@ interface AgentDefinition<N extends string = string, Prompt extends string = Sta
      * (handoffs, invokeTool, thread resumption) and their threads remain
      * visible; UIs use this flag to keep them out of top-level agent lists
      * and pickers so one logical product agent doesn't show up N times.
+     *
+     * The agent list route reports the flag on every entry. A request with
+     * `primary=true` returns only primary agents; a request without it
+     * returns non-primary agents too. The filter never changes which agents
+     * a caller may create a thread for.
      */
     readonly primary?: boolean;
     /**