Interface: McpPromptDefinition

Generated from the public TypeScript API.

An SDK-hosted MCP prompt; required arguments are checked before the callback runs.

​

Properties

​

arguments?

optional arguments?: object[];

​

description?

optional description?: string;

​

name

name: string;

​

required?

optional required?: boolean;

---

​

description?

optional description?: string;

---

​

name

name: string;

​

Methods

​

get()

get(arguments_, context):
  | {
[key: string]: unknown;
}
  | Promise<{
[key: string]: unknown;
}>;

Render this prompt after required arguments have been validated.

​

Parameters

arguments_

Record<string, string>

String arguments supplied by the MCP client.

context

ToolContext

Session identity and cancellation signal.

​

Returns

| { [key: string]: unknown; } | Promise<{ [key: string]: unknown; }>

MCP prompt messages.