Interface Prompt

interface Prompt {
    arguments?: PromptArgument[];
    description: string;
    name: string;
    render(
        args: Record<string, string>,
        ctx: ToolContext,
    ): GetPromptResult | Promise<GetPromptResult>;
}

Index

Properties

arguments? description name

Methods

Properties

`Optional`arguments

arguments?: PromptArgument[]

description

description: string

name

name: string

Methods

render

render(
args: Record<string, string>,
ctx: ToolContext,
): GetPromptResult | Promise<GetPromptResult>
Build the message list. Receives validated string args.
Parameters
- args: Record<string, string>
- ctx: ToolContext
Returns GetPromptResult | Promise<GetPromptResult>