Skip to main content
Glama

Save local review progress

review_progress
Idempotent

Read or save locally reviewed section progress for a pull request review without submitting changes to the provider.

Instructions

Read or save locally reviewed sections; never submits a provider review.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "review_id": "<review_id>"
    },
    "name": "review_progress"
  }
}

Input Schema

NameRequiredDescriptionDefault
sectionsNoReviewed section IDs; omit to read progress.
review_idYesReview snapshot ID.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.8/5.0
Behavior4/5

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

Annotations declare readOnlyHint=false with idempotentHint=true and destructiveHint=false, which on its own reads oddly for a tool that can also read. The description resolves that ambiguity by clarifying the write is local-only and never reaches the provider, which is real context beyond the structured fields. It still doesn't say what a save overwrites or how concurrent progress is merged.

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?

A single compact sentence with the mode distinction first and the key safety boundary second. Nothing is wasted and nothing important is buried.

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

Completeness4/5

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

For a two-parameter tool with full schema coverage and no output schema, the description covers purpose, the local-only side effect, and the implicit mode switch. What the read mode returns is left to be discovered, but that's a modest gap given the tool's simplicity.

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% and already documents both parameters, including 'omit to read progress' and the 40-item cap on sections. The description adds no syntax, ordering, or validation meaning beyond that, so the schema 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 specific dual verb ('read or save') against a specific resource ('locally reviewed sections'), which is enough to distinguish it from a submission tool. It does not name a sibling outright, and the read/write duality is only fully understood once you see that 'sections' being optional switches the mode.

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

Usage Guidelines3/5

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

The clause 'never submits a provider review' is a useful when-not boundary, implying this is the local/progress-tracking path rather than the publish path. There is no explicit statement of when to reach for this versus open_review or read_section, so the routing guidance is implied rather than stated.

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