Interface ForgeToolInput

Input arguments accepted by the forge_tool meta-tool.

Mirrors ForgeToolRequest but typed as a Record<string, any> to satisfy the ITool generic constraint while retaining semantic clarity.

interface ForgeToolInput {
    name: string;
    description: string;
    inputSchema: JSONSchemaObject;
    outputSchema?: JSONSchemaObject;
    implementation: {
        mode: "compose";
        steps: {
            name: string;
            tool: string;
            inputMapping: Record<string, unknown>;
        }[];
    } | {
        mode: "sandbox";
        code: string;
        allowlist: string[];
    };
    testCases: {
        input: Record<string, unknown>;
        expectedOutput?: unknown;
        stepOutputs?: Record<string, unknown>;
        responses?: ForgeTestResponse[];
    }[];
}

Hierarchy

  • Record<string, any>
    • ForgeToolInput

Properties

name description inputSchema outputSchema? implementation testCases

Properties

name

name: string

Machine-readable name for the new tool: an ASCII letter, then ASCII letters, digits, underscores and hyphens, at most 200 characters. Any other name is refused before the forge runs (see forgedToolNameProblem).

description

description: string

Natural language description of the tool's purpose.

inputSchema

inputSchema: JSONSchemaObject

JSON Schema for the tool's input arguments.

Optional outputSchema

outputSchema?: JSONSchemaObject

JSON Schema for the tool's expected output (optional).

implementation

implementation: {
    mode: "compose";
    steps: {
        name: string;
        tool: string;
        inputMapping: Record<string, unknown>;
    }[];
} | {
    mode: "sandbox";
    code: string;
    allowlist: string[];
}

Implementation specification — either compose (chain existing tools) or sandbox (arbitrary code). Discriminated on the mode field.

Type declaration

  • mode: "compose"
  • steps: {
        name: string;
        tool: string;
        inputMapping: Record<string, unknown>;
    }[]

Type declaration

  • mode: "sandbox"
  • code: string
  • allowlist: string[]

testCases

testCases: {
    input: Record<string, unknown>;
    expectedOutput?: unknown;
    stepOutputs?: Record<string, unknown>;
    responses?: ForgeTestResponse[];
}[]

One or more test cases for the judge to evaluate. Each has an input object and optional expectedOutput.

Type declaration

  • input: Record<string, unknown>
  • Optional expectedOutput?: unknown
  • Optional stepOutputs?: Record<string, unknown>
  • Optional responses?: ForgeTestResponse[]

Settings

Member Visibility

Theme

On This Page

namedescriptioninputSchemaoutputSchemaimplementationtestCases