Skip to main content
Glama

revue_show

Open a file in Revue, scroll to a specific line or range to point at code, or show its diff, rendered Markdown, SVG, or Mermaid diagram for review.

Instructions

Show the user a file in revue, optionally scrolled to a line or line range. Use this to point at specific code: "look at server.js lines 120-140". With a line it defaults to the whole-file view; without one, to the diff. view "preview" shows a markdown file rendered (with its mermaid diagrams drawn), an SVG drawn as an image, or a mermaid file's diagram. In a plain folder (not a git repo) it is the file or its preview.

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": {
      "path": "<path>"
    },
    "name": "revue_show"
  }
}

Input Schema

NameRequiredDescriptionDefault
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).
lineNoLine to scroll to and highlight. Not with view preview, which has no line numbers.
modeNoworking = uncommitted changes vs HEAD (default); commit = one commit vs its parent; branch = head vs its merge-base with base, like a PR.
pathYesFile path relative to the repo root.
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.
sideNoWhich version: new (after the change, default) or old (before it). Line numbers refer to this side.
viewNoWhole file, the diff, or the preview: the rendered markdown of a .md or .markdown file, an .svg file drawn as an image, or the diagram of a .mmd or .mermaid file (only for those files, and without line). Default: file if line is given, else diff.
newTabNoOpen a new browser tab even if a revue tab is already open.
endLineNoLast line of a range starting at line.
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

A3.6/5.0
Behavior3/5

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

No annotations are supplied, so the description carries the full disclosure burden. It does well on mode semantics (preview rendering for .md/.svg/.mmd, plain-folder fallback), but never says that this opens a browser UI for the user, that a local server may be started, or what the agent receives back from a "show" operation.

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?

Purpose and the concrete example are front-loaded, and the sentences are short. The trailing preview/plain-folder sentence duplicates information already in the schema, so there is some avoidable redundancy.

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 13-parameter tool with no annotations and no output schema, the description covers the mode/view matrix adequately but omits the agent-visible consequences: whether a server or browser tab is started, what is returned, and error behavior outside a repo. The `persist` and `newTab` parameters hint at side effects the description never explains.

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 every parameter is already documented in structured form, including the view/line defaults and the preview restriction. The description largely restates the preview and default rules already present in the `view` parameter, adding little semantics beyond the schema.

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 opening sentence gives a specific verb and resource ("Show the user a file in revue") plus the optional line-range scoping, and the example "look at server.js lines 120-140" makes the intent concrete. It doesn't explicitly distinguish itself from siblings such as revue_diff or revue_open, even though its `view: diff` mode clearly overlaps with them.

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

Usage Guidelines4/5

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

It states a clear use case (pointing at specific code) and explains the default-selection rule that governs behavior: whole-file view when a line is given, diff otherwise. What's missing is any when-not guidance or routing to revue_diff/revue_open for the overlapping diff case.

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