Skip to main content
Glama

review_propose_comment

Propose a code finding—bug, refactor, performance issue—anchored to a line range during a guided review. The human accepts, edits, or discards it; only accepted proposals become comments.

Instructions

Propose a finding on the code during a guided review — a bug, a refactor, a performance issue — anchored to a line range. Only a proposal: the human accepts, edits or discards it, and only an accepted one becomes a comment. Answers the proposal's id. For a question or missing context rather than a finding use review_propose; outside a guided review, comment_add.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
endNoLast line of the range, inclusive. Defaults to `line`.
bodyYesThe finding: what is wrong and why, in Markdown.
fileYesProject-relative path, e.g. `src/lib/api.ts`.
lineYesFirst line of the range, 1-based.
typeNoWhat the comment is about. Defaults to note.
sessionIdNoThe session id from the READO GUIDED REVIEW prompt. Omit it to use the newest session still open.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed10 schema fields changedv1.32.1
    • addedInput schema / properties / body / description
      Added value: +"The finding: what is wrong and why, in Markdown."
    • addedInput schema / properties / end / description
      Added value: +"Last line of the range, inclusive. Defaults to `line`."
    • addedInput schema / properties / end / minimum
      Added value: +1
    • changedInput schema / properties / end / type
      Previous value: -"number"New value: +"integer"
    • addedInput schema / properties / file / description
      Added value: +"Project-relative path, e.g. `src/lib/api.ts`."
    • addedInput schema / properties / line / description
      Added value: +"First line of the range, 1-based."
    • addedInput schema / properties / line / minimum
      Added value: +1
    • changedInput schema / properties / line / type
      Previous value: -"number"New value: +"integer"
    • addedInput schema / properties / sessionId / description
      Added value: +"The session id from the READO GUIDED REVIEW prompt. Omit it to use the newest session still open."
    • addedInput schema / properties / type / description
      Added value: +"What the comment is about. Defaults to note."
  2. First observedv1.32.0

TDQS

A4.7/5.0
Behavior5/5

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

Beyond the annotations (readOnlyHint=false, destructiveHint=false, idempotentHint=false), the description discloses the key behavioral trait: this only creates a proposal that the human accepts, edits, or discards, and only an accepted one becomes a comment. It also states the return value ('Answers the proposal's id'), which no structured field provides.

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?

Front-loaded with the core action, then the proposal lifecycle, then routing guidance. Every sentence carries distinct information with no restatement of the name or filler.

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?

No output schema exists, yet the description covers the return ('proposal's id') and the essential lifecycle (non-final until accepted). With 100% schema coverage and clear alternatives, nothing an agent needs to call this 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 description coverage is 100%, so parameters like line/end/file/type are already documented. The description's mention of line-range anchoring and the bug/refactor/performance examples only partially overlaps the enum values; it adds little syntax or format detail beyond the schema, so the 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 ('Propose a finding') and the anchoring mechanism (line range), with concrete examples of finding types. It names the sibling it is not for (review_propose) and the outside-context alternative (comment_add), so an agent can distinguish it without opening a schema.

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?

Explicit routing: 'For a question or missing context rather than a finding use review_propose; outside a guided review, comment_add.' Both the when-to-use and when-to-use-something-else paths are stated with the condition that selects them.

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