Section ID:
DOC-API-MODEL-schema-ou94n9qv48#overview
PromptDefinition
A prompt definition exposed by an MCP server
Meaning and usage
Section ID: DOC-API-MODEL-schema-ou94n9qv48#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-ou94n9qv48#fields
| Usage | Fields and validation |
|---|---|
| In responses | View fields |
In responses
Section ID: DOC-API-MODEL-schema-ou94n9qv48#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-ou94n9qv48#field-nameSection ID: DOC-API-MODEL-schema-ou94n9qv48#response-field-namename | string | Optional | Name identifying the prompt template on the MCP server. |
Section ID: DOC-API-MODEL-schema-ou94n9qv48#field-titleSection ID: DOC-API-MODEL-schema-ou94n9qv48#response-field-titletitle | string | Optional | Display title of the MCP prompt template. |
Section ID: DOC-API-MODEL-schema-ou94n9qv48#field-descriptionSection ID: DOC-API-MODEL-schema-ou94n9qv48#response-field-descriptiondescription | string | Optional | Description of the MCP prompt template’s purpose. |
Section ID: DOC-API-MODEL-schema-ou94n9qv48#field-parametersSection ID: DOC-API-MODEL-schema-ou94n9qv48#response-field-parametersparameters | Array of PromptParameter | Optional | Parameter definitions accepted by the prompt template. |
Section ID: DOC-API-MODEL-schema-ou94n9qv48#field-templateSection ID: DOC-API-MODEL-schema-ou94n9qv48#response-field-templatetemplate | string | Optional | Template string; clients may render with parameters. |
Where used
Section ID: DOC-API-MODEL-schema-ou94n9qv48#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 ID: DOC-API-MODEL-schema-ou94n9qv48