Skip to main content
Glama

Edit a code update

edit_code_update

Keep an edited version of a proposed article update without publishing it yet.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
itemIdYesThe proposal id from get_code_updates.
proposedYesThe whole article file, front matter included.
productIdYesProduct id from list_products.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare this as a non-readonly, non-destructive, non-idempotent write with no open-world access. The description usefully adds that the edit is held and not published, which annotations do not convey. However, it omits whether the saved version replaces the prior proposal, whether the edit can be revised again, and why the operation is non-idempotent.

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 tight sentence with no filler, and the non-publishing constraint is placed at the end as a qualifier. It is efficient, though the key state-changing verb is slightly buried behind 'keep an edited version'.

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

Completeness3/5

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

For a three-required-parameter write tool with full schema coverage, partial annotations, and no output schema, the description is minimally viable. It conveys the held-not-published behavior but leaves the workflow around approval, discarding, and re-editing unaddressed.

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 description coverage is 100%, so the schema already explains itemId (proposal id from get_code_updates), proposed (whole article file including front matter), and productId. The description adds no parameter-level detail, so the baseline of 3 applies.

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

Purpose4/5

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

States a concrete action (keep an edited version of a proposed article update) on a specific resource, and clarifies it does not publish. It is clear enough to act on, but it never distinguishes itself from close siblings such as approve_code_update, discard_code_update, or decide_code_update_batch.

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

Usage Guidelines2/5

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

There is no when-to-use guidance and no named alternative. The only contextual clue is the trailing 'without publishing it yet', which hints that publishing is a separate step but never points to the tool that performs it or explains when to edit versus approve or discard a proposal.

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