Skip to main content
Defined in: server/FastMCP.ts:98

Properties

auth?

optional auth?: AuthCheck;
Defined in: server/FastMCP.ts:124

description

description: string;
Defined in: server/FastMCP.ts:102

disabled?

optional disabled?: boolean;
Defined in: server/FastMCP.ts:121 When true the tool is hidden from listTools and cannot be invoked via tools/call.

input?

optional input?: StandardSchemaV1<unknown, unknown>;
Defined in: server/FastMCP.ts:104 Standard Schema validator for the tool’s input arguments. Used for runtime validation.

inputSchema?

optional inputSchema?: Record<string, unknown>;
Defined in: server/FastMCP.ts:110 Explicit JSON Schema advertised to clients as inputSchema. Overrides auto-generation from input. Use when you need JSON Schema features beyond what your validator auto-generates (e.g. examples, $comment, per-property descriptions, or custom annotations).

name

name: string;
Defined in: server/FastMCP.ts:99

output?

optional output?: StandardSchemaV1<unknown, unknown>;
Defined in: server/FastMCP.ts:112 Standard Schema validator for the tool’s return value. Validated before result conversion.

outputSchema?

optional outputSchema?: Record<string, unknown>;
Defined in: server/FastMCP.ts:117 Explicit JSON Schema advertised to clients as outputSchema. Overrides auto-generation from output. Use when you need JSON Schema features beyond what your validator auto-generates.

tags?

optional tags?: string[];
Defined in: server/FastMCP.ts:123 Arbitrary tags for server-side filtering.

timeout?

optional timeout?: number;
Defined in: server/FastMCP.ts:119 Execution timeout in milliseconds. No timeout by default.

title?

optional title?: string;
Defined in: server/FastMCP.ts:101 Human-readable display name shown in UIs. Takes precedence over name for display purposes.

ui?

optional ui?: UiToolMeta;
Defined in: server/FastMCP.ts:126 Apps extension — links this tool to a UI resource and controls visibility.