Skip to main content
Glama

revue_annotations

Lists or clears notes left on a code view to review feedback or remove comments, either for one view or across all views.

Instructions

List or clear notes left with revue_annotate. By default this acts on the notes of one view (mode/ref/base/head); all=true covers every view.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "revue_annotations"
  }
}

Input Schema

NameRequiredDescriptionDefault
idNoWith clear: remove only this note.
allNoEvery view, not just the given one.
gitNofalse opens the folder as a plain folder (its files only, including .git) even inside a git repo, like revue --no-git. Default true.
refNoCommit to show in commit mode (default HEAD).
baseNoBase branch in branch mode (default: main, master, origin/main, origin/master or develop, whichever exists).
headNoBranch to view in commit/branch mode without checking it out (default: the checked-out branch).
modeNoworking = uncommitted changes vs HEAD (default); commit = one commit vs its parent; branch = head vs its merge-base with base, like a PR.
repoNoAny folder inside the git repo. Defaults to the current working directory. A folder outside any repo opens as a plain folder: its files only, with no changes, history or modes.
actionNolist (default) or clear.
persistNoIf a server has to be started: true keeps it running after this agent session ends, false stops it with the session. Defaults to the --lifetime setting.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.4/5.0
Behavior2/5

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

No annotations are supplied, so the description carries the full behavioral burden for a tool that can delete notes. It never warns that clear is destructive or irreversible, doesn't mention whether a confirmation or specific permissions are needed, and says nothing about what list returns. Only the per-view versus all-views scope is disclosed.

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?

Two sentences, front-loaded with purpose before the scoping rule, with zero filler. Every clause adds information the schema does not already convey.

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?

For a 10-parameter tool with no annotations and no output schema, the description covers scope but leaves gaps: return shape of list, the destructive nature of clear, and interaction of the git/repo/persist parameters with this tool are unaddressed. Adequate to select and call coarsely, not complete for safe use of the clear action.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the schema baseline is already strong, yet the description adds real meaning the schema does not: it groups mode/ref/base/head as the four parameters that jointly define 'one view' and explains that all=true overrides that grouping. This is the one piece of cross-parameter semantics an agent needs and it is not inferable from the individual field descriptions.

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 verb pair and resource: 'List or clear notes left with revue_annotate.' Naming the sibling revue_annotate makes the create-vs-read separation explicit, so an agent can tell these two apart without opening schemas. It stops short of 5 only because the 'view' concept it depends on is defined by parameters rather than in the sentence itself.

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 description gives scoping guidance — default acts on one view (mode/ref/base/head), all=true covers every view — which tells the agent how to widen the operation. It does not state when to prefer this over siblings like revue_changes or revue_show, nor when to choose clear versus list beyond the action enum's default.

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