Skip to main content
Glama

review_plan

Set a guided review's ranked route before reviewing files, returning routed count and uncovered files left out of scope.

Instructions

Set a guided review's ranked route — the planning pass, once per session, before you review any file. Answers how many files you routed and the uncovered ones: files the scope contains that your route left out. Route each with review_propose_route_change, or declare it out of scope with reado session set-file <id> --file <path> --state out-of-scope. Refused if the session already has a route; propose a change instead.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
routeYesEvery file to review, riskiest first.
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. Changed4 schema fields changedv1.32.1
    • addedInput schema / properties / route / description
      Added value: +"Every file to review, riskiest first."
    • addedInput schema / properties / route / items / properties / relatedFiles / description
      Added value: +"Project-relative paths worth reading alongside it."
    • addedInput schema / properties / route / items / properties / suggestedReviewMode / description
      Added value: +"How closely the file deserves reading."
    • 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."
  2. First observedv1.32.0

TDQS

A4.4/5.0
Behavior4/5

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

Annotations cover the mutation profile (readOnlyHint=false, idempotentHint=false), and the description adds genuinely new behavior: the tool is single-shot per session and will be refused if a route exists, and it returns a routed-file count plus the 'uncovered' files the scope contains but the route left out. That post-condition and refusal semantics go beyond the structured fields.

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?

Front-loaded with the core action and timing, then alternatives, then the refusal rule. Dense but every sentence carries information; the inline CLI invocation for the out-of-scope path is the only slightly heavy element.

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 explains the return shape (routed count and uncovered files), the prerequisites, the single-use constraint, and the remedy when refused. An agent has everything needed to decide whether to call it and what to expect back.

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 'route' and 'sessionId' are already fully documented (including priority ordering, relatedFiles, and suggestedReviewMode). The description contextualizes the route via the uncovered-files concept but adds no parameter-level format or syntax 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 and resource ('Set a guided review's ranked route') and immediately scopes it as 'the planning pass, once per session, before you review any file.' That framing separates it from the sibling review_propose_route_change, which it explicitly names as the change path.

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?

Gives the timing ('once per session, before you review any file'), the downstream routing alternatives (review_propose_route_change for files in the route, an out-of-scope declaration for files not), and an explicit exclusion ('Refused if the session already has a route; propose a change instead'). When-to-use, when-not-to-use, and the alternative are all stated.

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