Skip to main content
Glama
JovianIce

git-bug-broker

by JovianIce

edit_body

Replace the body (first comment) of a git-bug entry. Validated against the entry's kind to ensure safe concurrent edits.

Instructions

Replace an entry's body (its first comment). Checked against the entry's kind.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes
bodyYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

C2.9/5.0
Behavior2/5

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

With no annotations, the description carries the full behavioral burden. It discloses that the operation replaces content and is checked against the entry's kind, but omits permission requirements, reversibility, what happens to the previous body, and error behavior for a mutation tool.

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?

The description is a single, front-loaded sentence with no filler. It is appropriately sized for a two-parameter tool, though the trailing validation clause is slightly cryptic.

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

Completeness2/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 annotations, no output schema, and 0% parameter coverage, the description is too thin. It does not explain return values, error cases, permission needs, or the exact meaning of 'checked against the entry's kind'.

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 0% for both parameters. The description clarifies that 'body' is the entry's first comment and 'id' identifies the entry, adding some meaning beyond the bare schema names. However, it provides no format, length, or content-type details for either parameter.

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 states a specific verb ('Replace') and resource ('entry's body (its first comment)'), making the core operation clear. It does not explicitly name the sibling 'edit_comment' as the alternative, so sibling differentiation is only implied rather than explicit.

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 when-to-use guidance, prerequisites, or alternatives are provided. The phrase 'Checked against the entry's kind' hints at a validation condition but does not tell the agent when to choose this tool over 'edit_comment' or other siblings.

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