PromptDefinition
A prompt definition exposed by an MCP server
Usage profiles
| Usage | Fields and validation |
|---|---|
| In responses | View fields |
In responses
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
name | string | Optional | Name identifying the prompt template on the MCP server. |
title | string | Optional | Display title of the MCP prompt template. |
description | string | Optional | Description of the MCP prompt template’s purpose. |
parameters | Array of PromptParameter | Optional | Parameter definitions accepted by the prompt template. |
template | string | Optional | Template string; clients may render with parameters. |
Where used
| Reference | Relationship |
|---|---|
| Get an MCP prompt template | POST /api/v1/llm/mcp-get-prompt |
| List MCP prompt templates | POST /api/v1/llm/mcp-list-prompts |
Download the public reference contract.
Document: DOC-API-MODEL-prompt-definition.