Resolve a prompt template at a remote MCP endpoint

POST

/v1/mcp/endpoints/{endpointId}/prompts/{name}

curl --request POST \
  --url https://example.com/v1/mcp/endpoints/example/prompts/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "arguments": { "additionalProperty": "example" } }'

• Same-origin — path relative to the deployment root.

Body carries { arguments?: Record<string, string> }. Returns the ordered message list the endpoint produced.

Authorizations

• bearerAuth

Parameters

Path Parameters

endpointId

required

string

>= 1 characters

MCPEndpointId — deployment-stable string identifier chosen by the caller.

name

required

string

>= 1 characters

Name of the prompt template at the remote endpoint.

Request Body

Media typeapplication/json

object

arguments

Argument bag for the prompt template. Every value must be a string per MCP spec.

object

key

additional properties

string

Example^generated

{
  "arguments": {
    "additionalProperty": "example"
  }
}

Responses

200

Rendered prompt messages.

Media typeapplication/json

object

messages

required

Array<object>

object

role

required

string

Allowed values: user assistant

content

required

One of:

object

object

type

required

string

Allowed value: text

text

required

string

object

object

type

required

string

Allowed value: image

data

required

Base64-encoded image bytes.

string

mimeType

required

string

Example

{
  "messages": [
    {
      "role": "user",
      "content": {
        "type": "text"
      }
    }
  ]
}

400

Malformed body.

Media typeapplication/json

object

error

required

object

code

required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string

message

required

string

details

Optional, kind-specific.

object

key

additional properties

any

requestId

required

Server-assigned request id; also echoed via X-Request-Id header.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

401

Missing / malformed / expired / revoked bearer token.

Media typeapplication/json

object

error

required

object

code

required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string

message

required

string

details

Optional, kind-specific.

object

key

additional properties

any

requestId

required

Server-assigned request id; also echoed via X-Request-Id header.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

404

No MCP endpoint or prompt with that name.

Media typeapplication/json

object

error

required

object

code

required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string

message

required

string

details

Optional, kind-specific.

object

key

additional properties

any

requestId

required

Server-assigned request id; also echoed via X-Request-Id header.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

502

Remote MCP endpoint failed to serve prompts/get.

Media typeapplication/json

object

error

required

object

code

required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string

message

required

string

details

Optional, kind-specific.

object

key

additional properties

any

requestId

required

Server-assigned request id; also echoed via X-Request-Id header.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}