@inkeep/agents-sdk 0.0.0-dev-20251008200151 → 0.0.0-dev-20251009005405

package/dist/index.d.cts

@@ -1,5 +1,5 @@
-import { MCPToolConfig as MCPToolConfig$1, ArtifactComponentInsert, CredentialReferenceApiInsert, DataComponentInsert, CredentialReferenceSelect, AgentApiInsert, ModelSettings, AgentStopWhen, DataComponentApiInsert, ArtifactComponentApiInsert, AgentConversationHistoryConfig, GraphStopWhen, StatusUpdateSettings, FullGraphDefinition, ToolInsert, McpTransportConfig, StopWhen, FullProjectDefinition } from '@inkeep/agents-core';
-export { ModelSettings } from '@inkeep/agents-core';
+import { MCPToolConfig as MCPToolConfig$1, ArtifactComponentInsert, CredentialReferenceApiInsert, DataComponentInsert, CredentialReferenceSelect, FunctionToolConfig, AgentApiInsert, ModelSettings, AgentStopWhen, DataComponentApiInsert, ArtifactComponentApiInsert, AgentConversationHistoryConfig, GraphStopWhen, StatusUpdateSettings, FullGraphDefinition, ToolInsert, McpTransportConfig, StopWhen, SandboxConfig, FullProjectDefinition } from '@inkeep/agents-core';
+export { FunctionToolConfig, ModelSettings, SandboxConfig } from '@inkeep/agents-core';
 import { z } from 'zod';
 
 interface ToolInterface {
@@ -200,6 +200,39 @@ declare function externalAgent(config: ExternalAgentConfig): ExternalAgent;
  */
 declare function externalAgents(configs: Record<string, ExternalAgentConfig>): Record<string, ExternalAgent>;
 
+interface FunctionToolInterface {
+    config: FunctionToolConfig;
+    getId(): string;
+    getName(): string;
+    getDescription(): string;
+    getInputSchema(): Record<string, unknown>;
+    getDependencies(): Record<string, string>;
+    getExecuteFunction(): (params: any) => Promise<any>;
+}
+declare class FunctionTool implements FunctionToolInterface {
+    config: FunctionToolConfig;
+    private id;
+    constructor(config: FunctionToolConfig);
+    getId(): string;
+    getName(): string;
+    getDescription(): string;
+    getInputSchema(): Record<string, unknown>;
+    getDependencies(): Record<string, string>;
+    getExecuteFunction(): (params: any) => Promise<any>;
+    serializeFunction(): {
+        id: string;
+        inputSchema: Record<string, unknown>;
+        executeCode: string;
+        dependencies: Record<string, string>;
+    };
+    serializeTool(): {
+        id: string;
+        name: string;
+        description: string;
+        functionId: string;
+    };
+}
+
 interface ArtifactComponentWithZodProps {
     id: string;
     name: string;
@@ -216,10 +249,13 @@ interface DataComponentWithZodProps {
 /**
  * Tool instance that may have additional metadata attached during agent processing
  */
-type AgentTool = Tool & {
+type AgentTool = (Tool & {
     selectedTools?: string[];
     headers?: Record<string, string>;
-};
+}) | (FunctionTool & {
+    selectedTools?: string[];
+    headers?: Record<string, string>;
+});
 interface UserMessage {
     role: 'user';
     content: string;
@@ -254,7 +290,7 @@ interface ToolResult {
     error?: string;
 }
 type AllAgentInterface = AgentInterface | ExternalAgentInterface;
-type AgentCanUseType = Tool | AgentMcpConfig;
+type AgentCanUseType = Tool | AgentMcpConfig | FunctionTool;
 interface AgentConfig extends Omit<AgentApiInsert, 'projectId'> {
     type?: 'internal';
     canUse?: () => AgentCanUseType[];
@@ -312,6 +348,7 @@ interface FetchDefinitionConfig {
     timeout?: number;
     credential?: CredentialReferenceApiInsert;
 }
+
 interface RequestSchemaDefinition {
     body?: z.ZodSchema<any>;
     headers?: z.ZodSchema<any>;
@@ -480,9 +517,10 @@ declare class Agent implements AgentInterface {
     private baseURL;
     private tenantId;
     private projectId;
+    private graphId;
     private initialized;
     constructor(config: AgentConfig);
-    setContext(tenantId: string, projectId: string, baseURL?: string): void;
+    setContext(tenantId: string, projectId: string, graphId: string, baseURL?: string): void;
     getId(): string;
     getName(): string;
     getInstructions(): string;
@@ -507,6 +545,7 @@ declare class Agent implements AgentInterface {
     private saveArtifactComponents;
     private loadDataComponents;
     private loadArtifactComponents;
+    private createFunctionTool;
     private createTool;
     private createDataComponent;
     private createArtifactComponent;
@@ -717,10 +756,12 @@ interface ProjectConfig {
         summarizer?: ModelSettings;
     };
     stopWhen?: StopWhen;
+    sandboxConfig?: SandboxConfig;
     graphs?: () => AgentGraph[];
     tools?: () => Tool[];
     dataComponents?: () => DataComponent[];
     artifactComponents?: () => ArtifactComponent[];
+    credentialReferences?: () => CredentialReferenceApiInsert[];
 }
 /**
  * Project interface for operations
@@ -784,9 +825,13 @@ declare class Project implements ProjectInterface {
     private initialized;
     private models?;
     private stopWhen?;
+    private sandboxConfig?;
     private graphs;
     private graphMap;
     private credentialReferences?;
+    private projectTools;
+    private projectDataComponents;
+    private projectArtifactComponents;
     constructor(config: ProjectConfig);
     /**
      * Set or update the configuration (tenantId and apiUrl)
@@ -1071,6 +1116,46 @@ declare function artifactComponent(config: ArtifactComponentConfig): ArtifactCom
  */
 declare function dataComponent(config: DataComponentConfig): DataComponent;
 declare function agentMcp(config: AgentMcpConfig): AgentMcpConfig;
+/**
+ * Creates a function tool that executes user-defined code in a sandboxed environment.
+ *
+ * Function tools allow users to define custom logic that runs securely in isolated
+ * environments. Dependencies are installed automatically in the sandbox.
+ *
+ * @param config - Function tool configuration
+ * @returns A FunctionTool instance
+ *
+ * @example
+ * ```typescript
+ * const calculatorTool = functionTool({
+ *   name: 'calculator',
+ *   description: 'Performs basic math operations',
+ *   inputSchema: {
+ *     type: 'object',
+ *     properties: {
+ *       operation: { type: 'string', enum: ['add', 'subtract', 'multiply', 'divide'] },
+ *       a: { type: 'number' },
+ *       b: { type: 'number' }
+ *     },
+ *     required: ['operation', 'a', 'b']
+ *   },
+ *   dependencies: {
+ *     'lodash': '^4.17.21'
+ *   },
+ *   execute: async (params) => {
+ *     const { operation, a, b } = params;
+ *     switch (operation) {
+ *       case 'add': return { result: a + b };
+ *       case 'subtract': return { result: a - b };
+ *       case 'multiply': return { result: a * b };
+ *       case 'divide': return { result: a / b };
+ *       default: throw new Error(`Unknown operation: ${operation}`);
+ *     }
+ *   }
+ * });
+ * ```
+ */
+declare function functionTool(config: FunctionToolConfig): FunctionTool;
 
 /**
  * Credential Reference System
@@ -1197,4 +1282,4 @@ declare const run: typeof Runner.run;
 declare const stream: typeof Runner.stream;
 declare const raceGraphs: typeof Runner.raceGraphs;
 
-export { Agent, type AgentCanUseType, type AgentConfig, AgentError, type AgentInterface, type AgentResponse, type AgentTool, type AllAgentInterface, ArtifactComponent, type ArtifactComponentInterface, type ArtifactComponentWithZodProps, type AssistantMessage, type BuilderAgentConfig, type BuilderRelationConfig, type BuilderToolConfig, type CredentialReference, DataComponent, type DataComponentInterface, type DataComponentWithZodProps, ExternalAgent, type ExternalAgentInterface, type ExtractCredentialIds, type FetchDefinitionConfig, type GenerateOptions, type GraphConfig, type GraphInterface, type MCPToolConfig, MaxTurnsExceededError, type Message, type MessageInput, Project, type RequestSchemaConfig, type RequestSchemaDefinition, type RunResult, Runner, type ServerConfig, type StreamEvent, type StreamResponse, type SystemMessage, Tool, type ToolCall, type ToolConfig, ToolExecutionError, type ToolMessage, type ToolResult, type TransferConfig, TransferError, type UnionCredentialIds, type UserMessage, agent, agentGraph, agentMcp, artifactComponent, createEnvironmentSettings, createFullProjectViaAPI, credential, credentialRef, dataComponent, deleteFullProjectViaAPI, externalAgent, externalAgents, getFullProjectViaAPI, isCredentialReference, mcpServer, mcpTool, project, raceGraphs, registerEnvironmentSettings, run, stream, transfer, updateFullProjectViaAPI };
+export { Agent, type AgentCanUseType, type AgentConfig, AgentError, type AgentInterface, type AgentResponse, type AgentTool, type AllAgentInterface, ArtifactComponent, type ArtifactComponentInterface, type ArtifactComponentWithZodProps, type AssistantMessage, type BuilderAgentConfig, type BuilderRelationConfig, type BuilderToolConfig, type CredentialReference, DataComponent, type DataComponentInterface, type DataComponentWithZodProps, ExternalAgent, type ExternalAgentInterface, type ExtractCredentialIds, type FetchDefinitionConfig, FunctionTool, type GenerateOptions, type GraphConfig, type GraphInterface, type MCPToolConfig, MaxTurnsExceededError, type Message, type MessageInput, Project, type RequestSchemaConfig, type RequestSchemaDefinition, type RunResult, Runner, type ServerConfig, type StreamEvent, type StreamResponse, type SystemMessage, Tool, type ToolCall, type ToolConfig, ToolExecutionError, type ToolMessage, type ToolResult, type TransferConfig, TransferError, type UnionCredentialIds, type UserMessage, agent, agentGraph, agentMcp, artifactComponent, createEnvironmentSettings, createFullProjectViaAPI, credential, credentialRef, dataComponent, deleteFullProjectViaAPI, externalAgent, externalAgents, functionTool, getFullProjectViaAPI, isCredentialReference, mcpServer, mcpTool, project, raceGraphs, registerEnvironmentSettings, run, stream, transfer, updateFullProjectViaAPI };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { MCPToolConfig as MCPToolConfig$1, ArtifactComponentInsert, CredentialReferenceApiInsert, DataComponentInsert, CredentialReferenceSelect, AgentApiInsert, ModelSettings, AgentStopWhen, DataComponentApiInsert, ArtifactComponentApiInsert, AgentConversationHistoryConfig, GraphStopWhen, StatusUpdateSettings, FullGraphDefinition, ToolInsert, McpTransportConfig, StopWhen, FullProjectDefinition } from '@inkeep/agents-core';
-export { ModelSettings } from '@inkeep/agents-core';
+import { MCPToolConfig as MCPToolConfig$1, ArtifactComponentInsert, CredentialReferenceApiInsert, DataComponentInsert, CredentialReferenceSelect, FunctionToolConfig, AgentApiInsert, ModelSettings, AgentStopWhen, DataComponentApiInsert, ArtifactComponentApiInsert, AgentConversationHistoryConfig, GraphStopWhen, StatusUpdateSettings, FullGraphDefinition, ToolInsert, McpTransportConfig, StopWhen, SandboxConfig, FullProjectDefinition } from '@inkeep/agents-core';
+export { FunctionToolConfig, ModelSettings, SandboxConfig } from '@inkeep/agents-core';
 import { z } from 'zod';
 
 interface ToolInterface {
@@ -200,6 +200,39 @@ declare function externalAgent(config: ExternalAgentConfig): ExternalAgent;
  */
 declare function externalAgents(configs: Record<string, ExternalAgentConfig>): Record<string, ExternalAgent>;
 
+interface FunctionToolInterface {
+    config: FunctionToolConfig;
+    getId(): string;
+    getName(): string;
+    getDescription(): string;
+    getInputSchema(): Record<string, unknown>;
+    getDependencies(): Record<string, string>;
+    getExecuteFunction(): (params: any) => Promise<any>;
+}
+declare class FunctionTool implements FunctionToolInterface {
+    config: FunctionToolConfig;
+    private id;
+    constructor(config: FunctionToolConfig);
+    getId(): string;
+    getName(): string;
+    getDescription(): string;
+    getInputSchema(): Record<string, unknown>;
+    getDependencies(): Record<string, string>;
+    getExecuteFunction(): (params: any) => Promise<any>;
+    serializeFunction(): {
+        id: string;
+        inputSchema: Record<string, unknown>;
+        executeCode: string;
+        dependencies: Record<string, string>;
+    };
+    serializeTool(): {
+        id: string;
+        name: string;
+        description: string;
+        functionId: string;
+    };
+}
+
 interface ArtifactComponentWithZodProps {
     id: string;
     name: string;
@@ -216,10 +249,13 @@ interface DataComponentWithZodProps {
 /**
  * Tool instance that may have additional metadata attached during agent processing
  */
-type AgentTool = Tool & {
+type AgentTool = (Tool & {
     selectedTools?: string[];
     headers?: Record<string, string>;
-};
+}) | (FunctionTool & {
+    selectedTools?: string[];
+    headers?: Record<string, string>;
+});
 interface UserMessage {
     role: 'user';
     content: string;
@@ -254,7 +290,7 @@ interface ToolResult {
     error?: string;
 }
 type AllAgentInterface = AgentInterface | ExternalAgentInterface;
-type AgentCanUseType = Tool | AgentMcpConfig;
+type AgentCanUseType = Tool | AgentMcpConfig | FunctionTool;
 interface AgentConfig extends Omit<AgentApiInsert, 'projectId'> {
     type?: 'internal';
     canUse?: () => AgentCanUseType[];
@@ -312,6 +348,7 @@ interface FetchDefinitionConfig {
     timeout?: number;
     credential?: CredentialReferenceApiInsert;
 }
+
 interface RequestSchemaDefinition {
     body?: z.ZodSchema<any>;
     headers?: z.ZodSchema<any>;
@@ -480,9 +517,10 @@ declare class Agent implements AgentInterface {
     private baseURL;
     private tenantId;
     private projectId;
+    private graphId;
     private initialized;
     constructor(config: AgentConfig);
-    setContext(tenantId: string, projectId: string, baseURL?: string): void;
+    setContext(tenantId: string, projectId: string, graphId: string, baseURL?: string): void;
     getId(): string;
     getName(): string;
     getInstructions(): string;
@@ -507,6 +545,7 @@ declare class Agent implements AgentInterface {
     private saveArtifactComponents;
     private loadDataComponents;
     private loadArtifactComponents;
+    private createFunctionTool;
     private createTool;
     private createDataComponent;
     private createArtifactComponent;
@@ -717,10 +756,12 @@ interface ProjectConfig {
         summarizer?: ModelSettings;
     };
     stopWhen?: StopWhen;
+    sandboxConfig?: SandboxConfig;
     graphs?: () => AgentGraph[];
     tools?: () => Tool[];
     dataComponents?: () => DataComponent[];
     artifactComponents?: () => ArtifactComponent[];
+    credentialReferences?: () => CredentialReferenceApiInsert[];
 }
 /**
  * Project interface for operations
@@ -784,9 +825,13 @@ declare class Project implements ProjectInterface {
     private initialized;
     private models?;
     private stopWhen?;
+    private sandboxConfig?;
     private graphs;
     private graphMap;
     private credentialReferences?;
+    private projectTools;
+    private projectDataComponents;
+    private projectArtifactComponents;
     constructor(config: ProjectConfig);
     /**
      * Set or update the configuration (tenantId and apiUrl)
@@ -1071,6 +1116,46 @@ declare function artifactComponent(config: ArtifactComponentConfig): ArtifactCom
  */
 declare function dataComponent(config: DataComponentConfig): DataComponent;
 declare function agentMcp(config: AgentMcpConfig): AgentMcpConfig;
+/**
+ * Creates a function tool that executes user-defined code in a sandboxed environment.
+ *
+ * Function tools allow users to define custom logic that runs securely in isolated
+ * environments. Dependencies are installed automatically in the sandbox.
+ *
+ * @param config - Function tool configuration
+ * @returns A FunctionTool instance
+ *
+ * @example
+ * ```typescript
+ * const calculatorTool = functionTool({
+ *   name: 'calculator',
+ *   description: 'Performs basic math operations',
+ *   inputSchema: {
+ *     type: 'object',
+ *     properties: {
+ *       operation: { type: 'string', enum: ['add', 'subtract', 'multiply', 'divide'] },
+ *       a: { type: 'number' },
+ *       b: { type: 'number' }
+ *     },
+ *     required: ['operation', 'a', 'b']
+ *   },
+ *   dependencies: {
+ *     'lodash': '^4.17.21'
+ *   },
+ *   execute: async (params) => {
+ *     const { operation, a, b } = params;
+ *     switch (operation) {
+ *       case 'add': return { result: a + b };
+ *       case 'subtract': return { result: a - b };
+ *       case 'multiply': return { result: a * b };
+ *       case 'divide': return { result: a / b };
+ *       default: throw new Error(`Unknown operation: ${operation}`);
+ *     }
+ *   }
+ * });
+ * ```
+ */
+declare function functionTool(config: FunctionToolConfig): FunctionTool;
 
 /**
  * Credential Reference System
@@ -1197,4 +1282,4 @@ declare const run: typeof Runner.run;
 declare const stream: typeof Runner.stream;
 declare const raceGraphs: typeof Runner.raceGraphs;
 
-export { Agent, type AgentCanUseType, type AgentConfig, AgentError, type AgentInterface, type AgentResponse, type AgentTool, type AllAgentInterface, ArtifactComponent, type ArtifactComponentInterface, type ArtifactComponentWithZodProps, type AssistantMessage, type BuilderAgentConfig, type BuilderRelationConfig, type BuilderToolConfig, type CredentialReference, DataComponent, type DataComponentInterface, type DataComponentWithZodProps, ExternalAgent, type ExternalAgentInterface, type ExtractCredentialIds, type FetchDefinitionConfig, type GenerateOptions, type GraphConfig, type GraphInterface, type MCPToolConfig, MaxTurnsExceededError, type Message, type MessageInput, Project, type RequestSchemaConfig, type RequestSchemaDefinition, type RunResult, Runner, type ServerConfig, type StreamEvent, type StreamResponse, type SystemMessage, Tool, type ToolCall, type ToolConfig, ToolExecutionError, type ToolMessage, type ToolResult, type TransferConfig, TransferError, type UnionCredentialIds, type UserMessage, agent, agentGraph, agentMcp, artifactComponent, createEnvironmentSettings, createFullProjectViaAPI, credential, credentialRef, dataComponent, deleteFullProjectViaAPI, externalAgent, externalAgents, getFullProjectViaAPI, isCredentialReference, mcpServer, mcpTool, project, raceGraphs, registerEnvironmentSettings, run, stream, transfer, updateFullProjectViaAPI };
+export { Agent, type AgentCanUseType, type AgentConfig, AgentError, type AgentInterface, type AgentResponse, type AgentTool, type AllAgentInterface, ArtifactComponent, type ArtifactComponentInterface, type ArtifactComponentWithZodProps, type AssistantMessage, type BuilderAgentConfig, type BuilderRelationConfig, type BuilderToolConfig, type CredentialReference, DataComponent, type DataComponentInterface, type DataComponentWithZodProps, ExternalAgent, type ExternalAgentInterface, type ExtractCredentialIds, type FetchDefinitionConfig, FunctionTool, type GenerateOptions, type GraphConfig, type GraphInterface, type MCPToolConfig, MaxTurnsExceededError, type Message, type MessageInput, Project, type RequestSchemaConfig, type RequestSchemaDefinition, type RunResult, Runner, type ServerConfig, type StreamEvent, type StreamResponse, type SystemMessage, Tool, type ToolCall, type ToolConfig, ToolExecutionError, type ToolMessage, type ToolResult, type TransferConfig, TransferError, type UnionCredentialIds, type UserMessage, agent, agentGraph, agentMcp, artifactComponent, createEnvironmentSettings, createFullProjectViaAPI, credential, credentialRef, dataComponent, deleteFullProjectViaAPI, externalAgent, externalAgents, functionTool, getFullProjectViaAPI, isCredentialReference, mcpServer, mcpTool, project, raceGraphs, registerEnvironmentSettings, run, stream, transfer, updateFullProjectViaAPI };