Neutrome SDK reference
    Preparing search index...

    Type Alias Tool

    A tool the model may call during a tool loop.

    type Tool = {
        description: string;
        name: string;
        schema: Record<string, unknown>;
        systemPromptFragment?: string;
        execute(
            args: Record<string, unknown>,
            ctx: ExecutorContext,
        ): Promise<string>;
    }
    Index
    description name schema systemPromptFragment?
    execute
    description: string

    Natural-language description shown to the model.

    name: string

    Tool name the model must use when calling it.

    schema: Record<string, unknown>

    JSON Schema describing the arguments.

    systemPromptFragment?: string

    Extra instructions appended to the system prompt when this tool is enabled.

    • Runs the tool.

      Parameters

      • args: Record<string, unknown>

        Arguments the model supplied, already parsed.

      • ctx: ExecutorContext

        Runtime services and execution identity.

      Returns Promise<string>

      The result, rendered as text for the model.

    Settings
    Member Visibility

    On This Page
    Properties
    Methods