@opscogs/octools
    Preparing search index...

    Class OCTool

    One agent tool, described once, convertible to any vendor's shape.

    The fields mirror the descriptor's wire keys in camelCase (input_schema is inputSchema). The constructor checks the structural invariants and throws OCToolError on the first one that fails, including a field the descriptor does not have. Instances are frozen.

    Index
    constructor
    access deprecated description destructiveHint func idempotentHint inputSchema meta name outputSchema readOnlyHint resultKind tags target title
    access: "local" | "remote"

    local or remote.

    deprecated: boolean

    The tool is kept only as an alias.

    description: string

    The model-facing description.

    destructiveHint: boolean

    A change the tool makes may destroy data.

    func: ToolFunc

    The function that does the work.

    idempotentHint: boolean

    Repeating a call has no further effect.

    inputSchema: JsonSchema

    JSON Schema of the arguments.

    meta: Readonly<Record<string, unknown>>

    Free-form JSON data for the runtime.

    name: string

    Lowercase snake_case, at most 48 characters.

    outputSchema: JsonSchema | null

    JSON Schema of the result, or null.

    readOnlyHint: boolean

    The tool changes nothing.

    resultKind: "records" | "artifact"

    records or artifact.

    tags: readonly string[]

    What the tool is, for a host to select by; recommended or advanced.

    target: string | null

    The remote system the tool reaches, or null.

    title: string | null

    A display name for a person, or null.

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties