lloyal-agents API Reference
    Preparing search index...

    Interface ToolSchema

    OpenAI-compatible function tool schema

    The wrapper format expected by formatChat() when passing tools to the model. Tool.schema generates this automatically from the tool's name, description, and parameters.

    interface ToolSchema {
        function: { description: string; name: string; parameters: JsonSchema };
        type: "function";
    }
    Index

    Properties

    function type

    Properties

    function: { description: string; name: string; parameters: JsonSchema }

    Function definition containing name, description, and parameter schema

    Type Declaration

    • description: string

      Human-readable description shown to the model

    • name: string

      Tool name — used as the function identifier in tool calls

    • parameters: JsonSchema

      JSON Schema describing the tool's arguments

    type: "function"

    Always "function" for function-calling tools

    Settings

    Member Visibility

    On This Page

    Properties