@suluk/agents - v0.1.6
    Preparing search index...

    Interface RouteToolDef

    A tool DERIVED from a route's operation — the runtime-agnostic shape every adapter renders its own way.

    interface RouteToolDef {
        key: string;
        description: string;
        schema: SchemaOrRef;
        approval?: { required: true; reason?: string };
        price?: PaidToolPrice;
        operationRef: string;
    }
    Index

    Properties

    key description schema approval? price? operationRef

    Properties

    key: string

    the wire-level tool id (the route key).

    description: string

    the LLM-facing description (the operation's summary/description; falls through an empty summary).

    schema: SchemaOrRef

    the input JSON Schema (the operation's body), fed verbatim to the runtime's tool factory.

    approval?: { required: true; reason?: string }

    the HITL gate from x-suluk-approval, when required (projects to e.g. the Agents SDK needsApproval).

    price?: PaidToolPrice

    the x402 paidTool price from x-suluk-cost, when a chargeable cost is declared (DECLARED, never enforced — C026).

    operationRef: string

    the by-name operationRef the tool dispatches to (used in the execute stub).

    Settings

    Member Visibility

    On This Page

    Properties