Skip to content
Français

defineMcpPrompt

import { defineMcpPrompt } from "@elie-laloum/outpost";

Declare instructions rendered at the start of each turn from a prompt of an MCP server declared on the same harness. Construction checks the server name, prompt name and string arguments without contacting the server; the turn fails with code configuration when that server is not running or offers no prompts.

Complete example and detailed rules.

  • optionsRequired
    McpPromptOptions
    Server, prompt name and string arguments of the prompt to render.
  • options.serverRequired
    string
    Name of an MCP server declared on the same harness that offers prompts.
  • options.nameRequired
    string
    Prompt name as listed by the server.
  • options.argumentsOptional
    Readonly<Record<string, string>> | undefined
    String arguments of the prompt, default none; values are passed as given.

HarnessInstructions

export declare function defineMcpPrompt(
  options: McpPromptOptions,
): HarnessInstructions;