Type Alias PromptCallback<TInput, TUser, HasOAuth, TEnv>

PromptCallback: (
    params: TInput,
    ctx: RequestContext<TUser, HasOAuth, TEnv>,
) =>
    | GetPromptResult
    | CallToolResult
    | InputRequiredResult
    | Promise<GetPromptResult | CallToolResult | InputRequiredResult>

Prompt execution callback. Prefer the SDK's raw GetPromptResult. Interactive prompts may return an InputRequiredResult.

Deprecated response helpers that return a CallToolResult are still accepted and converted at registration time.

Type Parameters

TInput = Record<string, unknown>
TUser = never
HasOAuth extends boolean = false
TEnv extends Env = Env

Type Declaration

- (
      params: TInput,
      ctx: RequestContext<TUser, HasOAuth, TEnv>,
  ):
      | GetPromptResult
      | CallToolResult
      | InputRequiredResult
      | Promise<GetPromptResult | CallToolResult | InputRequiredResult>
- Parameters
  - params: TInput
  - ctx: RequestContext<TUser, HasOAuth, TEnv>
  Returns
      | GetPromptResult
      | CallToolResult
      | InputRequiredResult
      | Promise<GetPromptResult | CallToolResult | InputRequiredResult>

Example

async ({ code }) => ({
  messages: [
    { role: "user", content: { type: "text", text: `Review:\n${code}` } },
  ],
})