WebMcpTool

Defines the structure of a WebMCP tool, including its name, description, and input/output JSON schemas used for tool registration and execution.

Props

The following table outlines the props for the WebMcpTool:

NameTypeDefaultDescription
annotations
object
-

A readOnlyHint flag indicating whether the tool performs read-only operations without modifying state.

description
string
-

A description of the tool's functionality and purpose.

execute
(args: object) => Promise<WebMcpToolResponse>
-

A function that executes the tool's logic when invoked. When not provided, the component binds a default handler based on the tool name.

inputSchema
object
-

The JSON schema object that defines the expected input parameters for the tool.

name
string
-

The unique identifier name of the WebMCP tool (e.g. 'createEvent', 'changeView').

outputSchema
object
-

The JSON schema object that defines the structure of the tool's output response.