Skip to main content
Glama

Update API template

update_api_template
Destructive

Update an api template's display_name and description (metadata only — this does NOT change the request definition; author that with create_api_template_version, and the slug cannot be changed). This is a WHOLESALE replace: display_name is required and description is set to exactly what you pass (an empty/omitted description CLEARS it), so to change one field while keeping the other, read the current values with get_api_template first and pass both.

Input Schema

NameRequiredDescriptionDefault
descriptionNoWhat this api template calls. Set wholesale — an empty value clears it.
template_idYesThe api template id to update.
display_nameYesHuman-readable name. Required (cannot be blank).

Output Schema

NameRequiredDescriptionDefault
slugYes
versionNo
definitionNo
descriptionYes
template_idYes
display_nameYes
latest_versionYes
last_published_versionYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.7/5.0
Behavior4/5

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

Adds real behavioral context beyond the annotations: this is a WHOLESALE replace, an omitted description CLEARS the field, and display_name is required. That is exactly the kind of data-loss nuance destructiveHint=true only hints at. Slightly short of 5 because it doesn't address validation failures or what the response confirms.

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?

Front-loaded with the scope statement, then the non-goal, then the replacement hazard, then the safe procedure. Three sentences, no filler, and the most dangerous fact (description is cleared if omitted) is stated before the remedy.

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?

For a 3-parameter mutation with an output schema available, the description covers scope, exclusions, destructive replacement semantics, required fields, and the read-before-write procedure. Nothing an agent needs to avoid data loss 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 baseline is 3; the description earns above that by explaining the wholesale-set semantics of description and the immutability of slug, which the schema does not state. It does not add format or length constraints for display_name beyond 'cannot be blank' already in the schema.

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?

States a specific verb (update) and resource (api template) plus the exact field scope: display_name and description, metadata only. It explicitly distinguishes itself from create_api_template_version, which authors the request definition, so an agent can route without inspecting schemas.

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

Usage Guidelines5/5

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

Gives explicit when-not guidance (this does NOT change the request definition — use create_api_template_version) and names an immutability constraint (slug cannot be changed). It also prescribes the correct call pattern: read current values with get_api_template first and pass both fields.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources