Interface PromptProvider<TPrompt>

Optional Readonlydescription

Optional ReadonlydisplayName

Optional Readonlyicon

Readonlyid

OptionaladdPrompt

• addPrompt?(partial: Partial<TPrompt>): Promise<TPrompt | AddPromptContext>

  Creates a new prompt from the given partial, or returns an AddPromptContext describing what additional inputs are needed.

  When partial contains enough information the provider creates the prompt and returns the full NormalizedPrompt. Otherwise it returns an AddPromptContext whose fields describe the form the UI should present to the user.

  Optional — providers that do not support creating prompts may omit it.

  Parameters

  • partial: Partial<TPrompt>

    Partially filled prompt data.

  Returns Promise<TPrompt | AddPromptContext>

execute

• execute(
      promptId: string,
      params: any[],
      options?: ExecuteOptions,
  ): Promise<void>

  Executes a prompt.

  Parameters

  • promptId: string

    ID of the prompt to run.

  • params: any[]

    Positional arguments forwarded to the prompt function.

  • Optionaloptions: ExecuteOptions

    Optional execution settings; see ExecuteOptions.

  Returns Promise<void>

getAllPrompts

• getAllPrompts(): Promise<TPrompt[]>

  Returns all prompts currently available from this provider.

  Returns Promise<TPrompt[]>

OptionalgetModelCatalog

• getModelCatalog?(): Promise<ModelCatalog>

  Returns the model catalog (known providers and popular models) for this provider's underlying SDK.

  Optional — providers that do not expose model info may omit it.

  Returns Promise<ModelCatalog>

OptionalgetModelParameters

• getModelParameters?(): PropDefinition[]

  Returns the list of editable model parameters exposed by this provider's underlying SDK (e.g. temperature, maxTokens).

  Optional — providers that do not expose model parameters may omit it.

  Returns PropDefinition[]

getPrompt

• getPrompt(id: string): Promise<TPrompt | null>

  Returns the prompt with the given ID, or null if not found.

  Parameters

  • id: string

    The prompt's unique identifier.

  Returns Promise<TPrompt | null>

OptionalrenamePrompt

• renamePrompt?(promptId: string, newName: string): Promise<TPrompt>

  Renames a prompt and returns the updated prompt with its new ID.

  Optional — providers that do not support renaming may omit it.

  Parameters

  • promptId: string

    ID of the prompt to rename.

  • newName: string

    The new name for the prompt.

  Returns Promise<TPrompt>

OptionalsetupTraceIngestion

• setupTraceIngestion?(): Promise<TraceIngestor | undefined>

  Performs whatever process-global setup this provider's tracing mechanism needs and returns the resulting TraceIngestor.

  Optional — providers with no tracing support may omit it.

  Returns Promise<TraceIngestor | undefined>

OptionalupdatePromptProperties

• updatePromptProperties?(
      promptId: string,
      updates: NormalizedPromptUpdates,
  ): Promise<TPrompt>

  Applies normalized updates to a prompt's source and returns the fresh prompt. Setting any field of updates to null removes the corresponding property from the underlying source.

  This method is optional; providers that do not support in-place editing may omit it.

  Parameters

  • promptId: string

    ID of the prompt to update.

  • updates: NormalizedPromptUpdates

    Updates expressed in the normalized vocabulary.

  Returns Promise<TPrompt>

Optionalwatch

• watch?(callback: (event: PromptChangeEvent) => void): () => void

  Registers a callback that is invoked whenever a prompt changes. Returns a cleanup function that stops the watcher when called.

  Optional — providers that cannot detect live changes may omit it.

  Parameters

  • callback: (event: PromptChangeEvent) => void

    Invoked with a PromptChangeEvent for each change.

  Returns () => void

  A no-argument function that unregisters the watcher.