Skip to main content
Glama
CodesWhat

portkey-admin-mcp

by CodesWhat
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

update_prompt

Modify an existing prompt by updating only specified fields, archiving the previous version. Supports structured messages, tools, and parameters to keep templates current.

Instructions

Update an existing prompt and create a new archived version. Only provided fields change, and publish_prompt is what makes the new version active. For multi-message chat prompts pass messages (preferred) or a JSON-encoded array as string.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoNew display name for the prompt
modelNoNew model identifier
toolsNoNew tool definitions
stringNoLegacy prompt template string. Use plain text for single-message prompts, or a JSON-encoded messages array string for multi-message chat prompts.
dry_runNoWhen true, validate without updating
messagesNoStructured chat template alias for updates. Serialized to the legacy string format before the prompt is updated.
functionsNoNew function definitions
prompt_idYesPrompt ID or slug to update
parametersNoNew default values for template variables
tool_choiceNoNew tool choice strategy
virtual_keyNoNew virtual key slug
collection_idNoMove to a different collection
is_raw_templateNoEnable or disable raw structural-template rendering
template_metadataNoNew metadata
version_descriptionNoDescription for this version

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
okYesWhether the tool call succeeded and returned structured data
dataNoStructured success payload when ok is true
errorNoStructured error payload when ok is false

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.11.5
    • addedInput schema / properties / is_raw_template
      Added value: +{
+  "description": "Enable or disable raw structural-template rendering",
+  "type": "boolean"
+}
  2. Addedv1.0.1
  3. Removed
  4. First observed

TDQS

A4.7/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Beyond the annotations, the description reveals important behavior: updates create a new archived version rather than mutating in place, only provided fields change, and the new version is not active until published. This is exactly the kind of behavioral context agents need.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is two sentences with no filler. The most important behaviors—archiving, partial updates, and activation—are front-loaded, and the parameter guidance is concise and directly actionable.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the rich input and output schemas, the description covers the critical operational details: versioning, activation, partial updates, and the messages-versus-string distinction. Nothing essential for selecting or invoking the tool correctly is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3. The description adds value by clarifying the preferred parameter for multi-message prompts and explaining the partial-update semantics, which supplements the schema's field-level documentation.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the operation: updating an existing prompt and creating a new archived version. It also distinguishes behavior from the sibling publish_prompt by noting that publishing is what activates the version, making the tool's role unmistakable.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explains the key workflow: update_prompt creates an archived version, but publish_prompt is required to make it active. It also gives concrete guidance for multi-message prompts, telling callers to prefer messages over a JSON-encoded string.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools