Function addTool

Adds a new tool to the tool registry for use by agents in the swarm system.

This function registers a new tool, enabling agents within the swarm to utilize it for performing specific tasks or operations. Tools must be registered through this function to be recognized by the swarm, though the original comment suggests an association with addAgent, likely intending that tools are linked to agent capabilities. The execution is wrapped in beginContext to ensure it runs outside of existing method and execution contexts, providing a clean execution environment. The function logs the operation if enabled and returns the tool's name upon successful registration.

Throws

If the tool schema is invalid or if registration fails due to conflicts or service errors (e.g., duplicate tool name).

Example

const toolSchema = { toolName: "Calculator", fn: (x: number) => x * 2, description: "Doubles a number" };
const toolName = addTool(toolSchema);
console.log(toolName); // Outputs "Calculator"
  • addTool<T extends unknown = Record<string, ToolValue>>(
        toolSchema: IAgentTool<T>,
    ): string

    Type Parameters

    • T extends unknown = Record<string, ToolValue>

      The type of the tool's input/output data, defaulting to a record of string keys and ToolValue values if unspecified.

    Parameters

    • toolSchema: IAgentTool<T>

      The schema defining the tool's properties, including its name (toolName) and other configuration details (e.g., function, description).

    Returns string

    The name of the newly added tool (toolSchema.toolName), confirming its registration.

Settings

Member Visibility