Interface ToolContract<Name>

Single source of truth for a public tool's name, description, and input.

interface ToolContract<Name extends string = string> {
    annotations: ToolAnnotations;
    description: string;
    examples: readonly ToolExample[];
    inputSchema: ZodObject;
    kind: ToolKind;
    name: Name;
    outputSchema: ZodObject;
}

Type Parameters

Name extends string = string

Index

Properties

annotations description examples inputSchema kind name outputSchema

Properties

`Readonly`annotations

annotations: ToolAnnotations

`Readonly`description

description: string

`Readonly`examples

examples: readonly ToolExample[]

`Readonly`inputSchema

inputSchema: ZodObject

`Readonly`kind

kind: ToolKind

`Readonly`name

name: Name

`Readonly`outputSchema

outputSchema: ZodObject