Skip to main content
Glama

Update instruction

update_instruction
Destructive

Rename an instruction document or rewrite its text whole. Only supplied fields change; content replaces the entire text, and an empty string clears it. Earlier text stays in the document's revision history. Read current text from its pizzadeveloper://projects/{projectId}/instructions/{id} resource first. During an active workflow run, instruction changes are accepted only in its self-improvement stage.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesId of the Instruction.
titleNoNew title.
contentNoFull replacement text; an empty string clears it.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.5/5.0
Behavior5/5

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

Beyond the destructiveHint annotation, the description discloses rich behavior: only supplied fields change, content is a full replacement, an empty string clears the text, and prior text is retained in revision history. The workflow-stage acceptance rule is a constraint no annotation conveys.

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?

Four tight sentences, front-loaded with the core mutation, then replacement semantics, history behavior, prerequisite read, and the workflow constraint. No sentence is filler and the ordering prioritizes what affects the call.

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 mutation tool with no output schema, the description covers the prerequisite read, the replacement/clearing behavior, reversibility (revision history), and the environmental timing constraint. Nothing an agent needs in order to call it correctly appears 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 id, title, and content including the empty-string-clear semantics. The description's 'only supplied fields change' adds partial-update meaning, but overall the schema does the heavy lifting, matching the baseline 3.

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 first sentence gives a specific verb-and-resource pair ('Rename an instruction document or rewrite its text whole') and makes the partial-update semantics explicit. An agent can distinguish this from create_instruction, delete_instruction, and archive_instruction without opening any schema.

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?

It gives a clear prerequisite ('Read current text ... resource first') and a timing constraint (mutations accepted only during a workflow run's self-improvement stage). It does not, however, explicitly name the read alternative or contrast with sibling update tools, so it stops short of full when/when-not routing.

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