Skip to main content
Glama

review_comment

Start a comment thread anchored to an exact quote in a file to flag a doubt, check a fact, or suggest a change, with optional note or question type.

Instructions

Start a new comment thread yourself, anchored on an exact quote from a file (or at the start of the file if quote is empty). Use it to point the user at something: a doubt, a fact to check, a suggestion.

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": {
      "file": "<file>",
      "text": "<text>"
    },
    "name": "review_comment"
  }
}

Input Schema

NameRequiredDescriptionDefault
fileYesPath relative to the workspace root (or absolute).
kindNoDefault note.
rootNoAbsolute path of the workspace folder. Optional when only one workspace is open.
textYes
quoteNoExact text from the file to anchor on.
occurrenceNoWhich occurrence of quote (default 1).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

B3.2/5.0
Behavior2/5

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

With no annotations, the description carries the full behavioral burden. It discloses the anchoring rule (empty quote means start of file) but omits critical context for a mutation tool: whether a review session must first be opened via review_open, whether the file must be open, what happens when the quote isn't found, and whether the call is idempotent or returns a thread identifier.

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?

Two tight sentences, front-loaded with the action and the anchoring mechanism. Every clause carries information; no filler or restatement of the tool name.

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 six-parameter mutation tool with no annotations and no output schema, the description covers the core mechanic but leaves the session prerequisites, failure modes, and return value unaddressed. An agent could invoke it but might do so outside a valid review session.

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 coverage is high at 83%, so the schema already documents file, kind, root, quote, and occurrence — baseline is 3. The description does add genuine meaning about quote (empty value anchors to file start), but says nothing about kind (note vs question) or occurrence disambiguation beyond what the schema states.

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?

Clear specific verb+resource: "Start a new comment thread" anchored on a quote from a file. The word "new" implicitly distinguishes it from review_reply and review_threads, though no sibling is named explicitly.

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?

It gives purpose-level guidance ("point the user at something: a doubt, a fact to check, a suggestion"), which is real context for when to use it. But it never mentions alternatives (e.g. review_reply for responding in an existing thread) or when not to use it, leaving the routing decision to inference.

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