Skip to main content
Glama

Update schema

update_schema
Destructive

Update a schema's display_name and description (metadata only — this does NOT change the JSON Schema body; author that with create_schema_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_schema first and pass both.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
schema_idYesThe schema id to update.
descriptionNoWhat this schema describes. Set wholesale — an empty value clears it.
display_nameYesHuman-readable name. Required (cannot be blank).

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
slugYes
versionNo
schema_idYes
descriptionYes
json_schemaNo
display_nameYes
latest_versionYes
last_published_versionYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already carry destructiveHint=true and readOnlyHint=false, but the description adds critical behavioral detail beyond them: the WHOLESALE replace semantics, that description is set to exactly what you pass, that an empty/omitted description CLEARS it, and that display_name is required and cannot be blank. This surfaces the destructive edge cases the annotation only hints at.

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

Conciseness4/5

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

A single dense paragraph, front-loaded with the core purpose and scoping before the wholesale warning. Every sentence carries information, though it is somewhat long and could be split for scanability. Slightly above average for a tool with complex destructive semantics.

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 destructive mutation with no idempotentHint, the description fully covers the failure modes: what is and isn't changed, the clearing behavior, the required field, and the safe procedure for partial updates. With an output schema present, return-value documentation is not needed. Nothing an agent needs to call it correctly is missing.

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

Parameters3/5

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

Schema coverage is 100%, so the schema already documents all three parameters, including 'Set wholesale — an empty value clears it' for description. The description adds the cross-parameter interaction (must pass both to change one) which is genuinely useful, but the schema carries most of the parameter burden, so baseline 3 applies.

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+resource+fields: 'Update a schema's display_name and description'. Explicitly scopes itself to metadata-only and distinguishes from the sibling create_schema_version (which authors the JSON Schema body), so an agent can tell them apart without opening 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 JSON Schema body; use create_schema_version for that) and names the alternative for safe partial updates (read current values with get_schema first). Also notes the immutable slug. Nothing is left to inference.

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