@inkeep/agents-sdk 0.73.5 → 0.74.0

package/dist/index.d.ts

@@ -6,7 +6,7 @@ import { transfer } from "./builders.js";
 import { DataComponent, DataComponentInterface } from "./data-component.js";
 import { ExternalAgent, externalAgent, externalAgents } from "./external-agent.js";
 import { FunctionTool } from "./function-tool.js";
-import { AgentConfig, AgentError, AgentInterface, AgentResponse, AgentTool, AllDelegateInputInterface, AllDelegateOutputInterface, AssistantMessage, BuilderAgentConfig, BuilderRelationConfig, BuilderToolConfig, ExternalAgentInterface, FetchDefinitionConfig, FunctionToolConfig, GenerateOptions, MCPToolConfig, MaxTurnsExceededError, Message, MessageInput, ModelSettings, RequestSchemaConfig, RequestSchemaDefinition, RunResult, ServerConfig, SkillDefinition, SkillReference, StreamEvent, StreamResponse, SubAgentCanUseType, SubAgentConfig, SubAgentInterface, SystemMessage, ToolCall, ToolConfig, ToolExecutionError, ToolMessage, ToolResult, TransferConfig, TransferError, UserMessage, subAgentExternalAgentInterface, subAgentTeamAgentInterface } from "./types.js";
+import { AgentConfig, AgentError, AgentInterface, AgentResponse, AgentTool, AllDelegateInputInterface, AllDelegateOutputInterface, AssistantMessage, BuilderAgentConfig, BuilderRelationConfig, BuilderToolConfig, ExternalAgentInterface, FetchDefinitionConfig, FunctionToolConfig, GenerateOptions, MCPToolConfig, MaxTurnsExceededError, Message, MessageInput, ModelSettings, OutputContract, RequestSchemaConfig, RequestSchemaDefinition, RunResult, ServerConfig, SkillDefinition, SkillReference, StreamEvent, StreamResponse, SubAgentCanUseType, SubAgentConfig, SubAgentInterface, SystemMessage, ToolCall, ToolConfig, ToolExecutionError, ToolMessage, ToolResult, TransferConfig, TransferError, UserMessage, subAgentExternalAgentInterface, subAgentTeamAgentInterface } from "./types.js";
 import { Project, ProjectConfig } from "./project.js";
 import { StatusComponent, StatusComponentInterface } from "./status-component.js";
 import { agent, agentMcp, artifactComponent, credential, dataComponent, functionTool, mcpServer, mcpTool, project, statusComponent, subAgent, trigger } from "./builderFunctions.js";
@@ -19,4 +19,4 @@ import { Runner, raceAgents, run, stream } from "./runner.js";
 import { loadSkills } from "./skill-loader.js";
 import { ConsoleTelemetryProvider, InkeepTelemetryProvider, NoOpTelemetryProvider, OpenTelemetryConfig, SpanOptions, SpanStatus, SpanStatusType, TelemetryConfig, TelemetryLogger, TelemetryMetrics, TelemetryProvider, TelemetrySpan, TelemetryTracer, createConsoleTelemetryProvider, createNoOpTelemetryProvider, createOpenTelemetryProvider, getGlobalTelemetryProvider, setGlobalTelemetryProvider } from "./telemetry-provider.js";
 import { ANTHROPIC_MODELS, GOOGLE_MODELS, OPENAI_MODELS, SignatureSource, SignatureVerificationConfig, SignedComponent } from "@inkeep/agents-core";
-export { ANTHROPIC_MODELS, AgentConfig, AgentError, AgentInterface, AgentResponse, AgentTool, AllDelegateInputInterface, AllDelegateOutputInterface, ArtifactComponent, type ArtifactComponentInterface, AssistantMessage, BuilderAgentConfig, BuilderRelationConfig, BuilderToolConfig, ConsoleTelemetryProvider, type CredentialProviderConfig, type CredentialProviderType, type CredentialReference, type CredentialStore, type CustomCredentialConfig, DataComponent, type DataComponentInterface, EvaluationClient, type EvaluationClientConfig, ExternalAgent, ExternalAgentInterface, type ExtractCredentialIds, FetchDefinitionConfig, FunctionTool, FunctionToolConfig, GOOGLE_MODELS, GenerateOptions, InkeepCredentialProvider, InkeepTelemetryProvider, type KeychainCredentialConfig, MCPToolConfig, MaxTurnsExceededError, type MemoryCredentialConfig, Message, MessageInput, ModelSettings, type NangoCredentialConfig, NoOpTelemetryProvider, OPENAI_MODELS, type OpenTelemetryConfig, Project, type ProjectConfig, RequestSchemaConfig, RequestSchemaDefinition, RunResult, Runner, ServerConfig, type SignatureSource, type SignatureVerificationConfig, type SignedComponent, SkillDefinition, SkillReference, type SpanOptions, SpanStatus, type SpanStatusType, StatusComponent, type StatusComponentInterface, StreamEvent, StreamResponse, SubAgent, SubAgentCanUseType, SubAgentConfig, SubAgentInterface, SystemMessage, type TelemetryConfig, type TelemetryLogger, type TelemetryMetrics, type TelemetryProvider, type TelemetrySpan, type TelemetryTracer, Tool, ToolCall, ToolConfig, ToolExecutionError, ToolMessage, ToolResult, TransferConfig, TransferError, Trigger, type TriggerConfig, type TriggerInterface, type UnionCredentialIds, UserMessage, agent, agentMcp, artifactComponent, createConsoleTelemetryProvider, createCredentialProvider, createEnvironmentSettings, createFullProjectViaAPI, createNoOpTelemetryProvider, createOpenTelemetryProvider, credential, credentialRef, dataComponent, deleteFullProjectViaAPI, evaluationClient, externalAgent, externalAgents, functionTool, getFullProjectViaAPI, getGlobalTelemetryProvider, isCredentialReference, loadSkills, mcpServer, mcpTool, project, raceAgents, registerEnvironmentSettings, run, setGlobalTelemetryProvider, statusComponent, stream, subAgent, subAgentExternalAgentInterface, subAgentTeamAgentInterface, transfer, trigger, updateFullProjectViaAPI };
+export { ANTHROPIC_MODELS, AgentConfig, AgentError, AgentInterface, AgentResponse, AgentTool, AllDelegateInputInterface, AllDelegateOutputInterface, ArtifactComponent, type ArtifactComponentInterface, AssistantMessage, BuilderAgentConfig, BuilderRelationConfig, BuilderToolConfig, ConsoleTelemetryProvider, type CredentialProviderConfig, type CredentialProviderType, type CredentialReference, type CredentialStore, type CustomCredentialConfig, DataComponent, type DataComponentInterface, EvaluationClient, type EvaluationClientConfig, ExternalAgent, ExternalAgentInterface, type ExtractCredentialIds, FetchDefinitionConfig, FunctionTool, FunctionToolConfig, GOOGLE_MODELS, GenerateOptions, InkeepCredentialProvider, InkeepTelemetryProvider, type KeychainCredentialConfig, MCPToolConfig, MaxTurnsExceededError, type MemoryCredentialConfig, Message, MessageInput, ModelSettings, type NangoCredentialConfig, NoOpTelemetryProvider, OPENAI_MODELS, type OpenTelemetryConfig, OutputContract, Project, type ProjectConfig, RequestSchemaConfig, RequestSchemaDefinition, RunResult, Runner, ServerConfig, type SignatureSource, type SignatureVerificationConfig, type SignedComponent, SkillDefinition, SkillReference, type SpanOptions, SpanStatus, type SpanStatusType, StatusComponent, type StatusComponentInterface, StreamEvent, StreamResponse, SubAgent, SubAgentCanUseType, SubAgentConfig, SubAgentInterface, SystemMessage, type TelemetryConfig, type TelemetryLogger, type TelemetryMetrics, type TelemetryProvider, type TelemetrySpan, type TelemetryTracer, Tool, ToolCall, ToolConfig, ToolExecutionError, ToolMessage, ToolResult, TransferConfig, TransferError, Trigger, type TriggerConfig, type TriggerInterface, type UnionCredentialIds, UserMessage, agent, agentMcp, artifactComponent, createConsoleTelemetryProvider, createCredentialProvider, createEnvironmentSettings, createFullProjectViaAPI, createNoOpTelemetryProvider, createOpenTelemetryProvider, credential, credentialRef, dataComponent, deleteFullProjectViaAPI, evaluationClient, externalAgent, externalAgents, functionTool, getFullProjectViaAPI, getGlobalTelemetryProvider, isCredentialReference, loadSkills, mcpServer, mcpTool, project, raceAgents, registerEnvironmentSettings, run, setGlobalTelemetryProvider, statusComponent, stream, subAgent, subAgentExternalAgentInterface, subAgentTeamAgentInterface, transfer, trigger, updateFullProjectViaAPI };

package/dist/subAgent.d.ts

@@ -38,6 +38,7 @@ declare class SubAgent implements SubAgentInterface {
   addTool(_name: string, tool: Tool): void;
   addTransfer(...agents: SubAgentInterface[]): void;
   addDelegate(...agents: AllDelegateInputInterface[]): void;
+  private validateOutputContract;
   init(): Promise<void>;
   private upsertAgent;
   private saveToolsAndRelations;

package/dist/subAgent.js

@@ -211,8 +211,23 @@ var SubAgent = class {
 			this.config.canDelegateTo = () => [...existingDelegates(), ...agents];
 		} else this.config.canDelegateTo = () => agents;
 	}
+	validateOutputContract() {
+		const contract = this.config.outputContract;
+		if (!contract) return;
+		if (contract.requireTransfer === true && ((contract.requireComponent?.length ?? 0) > 0 || (contract.requireArtifact?.length ?? 0) > 0)) throw new Error(`outputContract on sub-agent '${this.getId()}' combines requireTransfer with requireComponent/requireArtifact — a turn has a single terminal output shape, so requireTransfer is mutually exclusive with them`);
+		if (contract.requireComponent?.length) {
+			const declared = this.getDataComponents().map((component) => component.name);
+			for (const name of contract.requireComponent) if (!declared.includes(name)) throw new Error(`outputContract.requireComponent='${name}' references an undeclared dataComponent on sub-agent '${this.getId()}'`);
+		}
+		if (contract.requireArtifact?.length) {
+			const declared = this.getArtifactComponents().map((component) => component.name);
+			for (const name of contract.requireArtifact) if (!declared.includes(name)) throw new Error(`outputContract.requireArtifact='${name}' references an undeclared artifactComponent on sub-agent '${this.getId()}'`);
+		}
+		if (contract.requireTransfer && this.getTransfers().length === 0) throw new Error(`outputContract.requireTransfer is true but sub-agent '${this.getId()}' declares no canTransferTo() targets`);
+	}
 	async init() {
 		if (this.initialized) return;
+		this.validateOutputContract();
 		try {
 			await this.upsertAgent();
 			await this.loadDataComponents();
@@ -238,7 +253,8 @@ var SubAgent = class {
 			prompt: this.config.prompt || "",
 			conversationHistoryConfig: this.config.conversationHistoryConfig,
 			models: this.config.models,
-			stopWhen: this.config.stopWhen
+			stopWhen: this.config.stopWhen,
+			outputContract: this.config.outputContract
 		};
 		const updateResponse = await fetch(`${this.baseURL}/manage/tenants/${this.tenantId}/agents/${this.getId()}`, {
 			method: "PUT",

package/dist/types.d.ts

@@ -5,7 +5,7 @@ import { AgentMcpConfig } from "./builders.js";
 import { DataComponentInterface } from "./data-component.js";
 import { ExternalAgentConfig } from "./external-agent.js";
 import { FunctionTool } from "./function-tool.js";
-import { AgentConversationHistoryConfig, AgentStopWhen, ArtifactComponentApiInsert, CredentialReferenceApiInsert, DataComponentApiInsert, FullAgentDefinition, FunctionToolConfig, McpTransportConfig, ModelSettings, SkillApiInsertSchema, StatusUpdateSettings, SubAgentApiInsert, ToolInsert, ToolPolicy } from "@inkeep/agents-core";
+import { AgentConversationHistoryConfig, AgentStopWhen, ArtifactComponentApiInsert, CredentialReferenceApiInsert, DataComponentApiInsert, FullAgentDefinition, FunctionToolConfig, McpTransportConfig, ModelSettings, OutputContract, SkillApiInsertSchema, StatusUpdateSettings, SubAgentApiInsert, ToolInsert, ToolPolicy } from "@inkeep/agents-core";
 import { z } from "zod";
 
 //#region src/types.d.ts
@@ -73,7 +73,7 @@ type SkillReference = string | {
 type AllDelegateInputInterface = SubAgentInterface | subAgentExternalAgentInterface | ExternalAgentInterface | AgentInterface | subAgentTeamAgentInterface;
 type AllDelegateOutputInterface = SubAgentInterface | subAgentExternalAgentInterface | subAgentTeamAgentInterface;
 type SubAgentCanUseType = Tool | AgentMcpConfig | FunctionTool;
-interface SubAgentConfig extends Omit<SubAgentApiInsert, "projectId"> {
+interface SubAgentConfig extends Omit<SubAgentApiInsert, "projectId" | "outputContract"> {
   type?: "internal";
   canUse?: () => SubAgentCanUseType[];
   canTransferTo?: () => SubAgentInterface[];
@@ -82,6 +82,7 @@ interface SubAgentConfig extends Omit<SubAgentApiInsert, "projectId"> {
   dataComponents?: () => (DataComponentApiInsert | DataComponentInterface)[];
   artifactComponents?: () => (ArtifactComponentApiInsert | ArtifactComponentInterface)[];
   conversationHistoryConfig?: AgentConversationHistoryConfig;
+  outputContract?: OutputContract;
 }
 interface ToolConfig extends ToolInsert {
   execute: (params: any) => Promise<any>;
@@ -314,4 +315,4 @@ interface BuilderAgentConfig {
   relations?: BuilderRelationConfig[];
 }
 //#endregion
-export { AgentConfig, AgentError, AgentInterface, AgentResponse, AgentTool, AllDelegateInputInterface, AllDelegateOutputInterface, AssistantMessage, BuilderAgentConfig, BuilderRelationConfig, BuilderToolConfig, ExternalAgentInterface, FetchDefinitionConfig, type FunctionToolConfig, GenerateOptions, MCPToolConfig, MaxTurnsExceededError, Message, MessageInput, type ModelSettings, RequestSchemaConfig, RequestSchemaDefinition, RunResult, ServerConfig, SkillDefinition, SkillReference, StreamEvent, StreamResponse, SubAgentCanUseType, SubAgentConfig, SubAgentInterface, SystemMessage, ToolCall, ToolConfig, ToolExecutionError, ToolMessage, ToolResult, TransferConfig, TransferError, type TriggerInterface, UserMessage, subAgentExternalAgentInterface, subAgentTeamAgentInterface };
+export { AgentConfig, AgentError, AgentInterface, AgentResponse, AgentTool, AllDelegateInputInterface, AllDelegateOutputInterface, AssistantMessage, BuilderAgentConfig, BuilderRelationConfig, BuilderToolConfig, ExternalAgentInterface, FetchDefinitionConfig, type FunctionToolConfig, GenerateOptions, MCPToolConfig, MaxTurnsExceededError, Message, MessageInput, type ModelSettings, type OutputContract, RequestSchemaConfig, RequestSchemaDefinition, RunResult, ServerConfig, SkillDefinition, SkillReference, StreamEvent, StreamResponse, SubAgentCanUseType, SubAgentConfig, SubAgentInterface, SystemMessage, ToolCall, ToolConfig, ToolExecutionError, ToolMessage, ToolResult, TransferConfig, TransferError, type TriggerInterface, UserMessage, subAgentExternalAgentInterface, subAgentTeamAgentInterface };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inkeep/agents-sdk",
-  "version": "0.73.5",
+  "version": "0.74.0",
   "description": "Agents SDK for building and managing agents in the Inkeep Agent Framework",
   "types": "dist/index.d.ts",
   "type": "module",
@@ -16,7 +16,7 @@
     "js-yaml": "^4.1.0",
     "typescript": "^6.0.2",
     "zod": "^4.3.6",
-    "@inkeep/agents-core": "^0.73.5"
+    "@inkeep/agents-core": "^0.74.0"
   },
   "peerDependencies": {
     "@opentelemetry/api": "^1.0.0"