truegrain - v1.1.0
    Preparing search index...

    Interface ToolSpec

    One tool, in the function-schema shape most agent frameworks accept.

    interface ToolSpec {
        function: {
            description: string;
            name: "query" | "list_metrics" | "describe_metric" | "list_dimensions";
            parameters: Record<string, unknown>;
        };
        type: "function";
    }
    Index
    function type
    function: {
        description: string;
        name: "query" | "list_metrics" | "describe_metric" | "list_dimensions";
        parameters: Record<string, unknown>;
    }

    The callable itself.

    Type Declaration

    • description: string

      Written for a model rather than a human: when to use this, and when not to.

    • name: "query" | "list_metrics" | "describe_metric" | "list_dimensions"

      The name the model calls back with; pass it to dispatch.

    • parameters: Record<string, unknown>

      JSON Schema for the arguments.

    type: "function"

    Always "function", which is what the frameworks expect.

    Settings
    Member Visibility

    On This Page
    Properties