Skip to main content
Glama

edit_issue

Replaces an issue's text content.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
contentYesThe issue's new text content, replacing what's there now.
issueKeyYesThe issue's key, e.g. 'BRD-42'.
attributesNoAttribute name -> plain-text value, same as create_issue. Omit to leave every attribute untouched (not cleared).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.1/5.0
Behavior2/5

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

With no annotations, the description must disclose behavioral traits itself; 'Replaces' signals that old content is overwritten, but it does not mention side effects on attributes, permissions, or return behavior. The schema discloses the attribute default, but the free-text description adds little beyond the mutation verb.

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 a single front-loaded sentence with no filler. It states the action and object directly, earning its place.

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?

All parameters are documented in the schema, and the tool's core action is clear, so an agent could invoke it correctly. However, there is no output schema and no description of the result or failure conditions, leaving a moderate gap for a mutation tool.

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 parameters are already well documented. The description adds only the phrase 'text content,' which roughly maps to the content parameter and does not improve on the schema's explanation.

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?

The description uses a specific verb ('Replaces') and names the target resource ('an issue's text content'), making it easy to distinguish from edit_comment and update_issue_status. It is slightly incomplete because it omits the tool's ability to update attributes, which is part of the input schema.

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?

No guidance is given about when to choose edit_issue over create_issue, edit_comment, or update_issue_status. The description implies use for modifying an existing issue's content, but it never states that, notes prerequisites, or names alternatives.

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.