Whatever message this page gives is out now! Go check it out!
getPrompt
Last update:
May 18, 2026
Retrieves the full, resolved definition of a specific prompt from the MCP server, optionally accepting argument values to produce a ready-to-use prompt payload.
Description
The
getPrompt function retrieves the full, resolved definition of a specific prompt from the MCP server. While listPrompts() gives you a catalog of prompt names, titles, descriptions, and argument definitions, getPrompt lets you:- Fetch a prompt by name.
- Optionally provide argument values.
- Receive a fully constructed prompt payload (often including ready-to-use messages) that your application or AI service can send directly to a model.
Returns
A struct representing the JSON-RPC result of
prompts/get.Syntax
function getPrompt(struct params)Called as an instance method on an MCP client object:
promptDef = mcpClient.getPrompt(params);History
New in ColdFusion 2025.0.08
Parameters
| Field | Data type | Required | Description |
|---|---|---|---|
name | String | Yes | Name of the prompt to fetch (must match one of the names returned by listPrompts()). |
params | Struct | No | Key/value pairs for prompt arguments (e.g. { code = "..." }); used to fill the template or generate messages. |
We're glad. Tell us how this page helped.
We're sorry. Can you tell us what didn't work for you?
Share additional feedback to help us improve.
0/255
|
