Skip to main content
Glama
Sign In
doc-review

doc-review

by MichaelEight
OverviewSchemaSourceRelated ServersDiscussionsAdmin
JavaScript
Local

review_resolve

Marks a review comment as handled and records a short note shown to the user, so each comment thread can be closed with a clear record of the change made.

Instructions

Mark a comment as handled, with a short note shown to the user (e.g. "Corrected", "Rewrote the intro as asked").

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": {
      "comment_id": "<comment_id>"
    },
    "name": "review_resolve"
  }
}

Input Schema

NameRequiredDescriptionDefault
noteNo
comment_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

B3.2/5.0
Behavior3/5

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

With no annotations, the description carries the full burden, and it does disclose one important behavioral fact: the note is shown to the user, so its content is user-visible. It does not say whether resolution is reversible, whether a resolved comment can still be replied to, or what happens to the thread afterwards, which leaves significant mutation semantics undisclosed.

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?

A single tight sentence with the core action front-loaded, and the parenthetical examples earn their place by showing expected note style and length. Nothing is redundant, though the sentence carries no structural cues for the second parameter.

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 two-parameter mutation with no annotations and no output schema, the definition covers the action and the note semantics. It falls short on outcome and lifecycle information — whether the comment can be reopened, whether a confirmation or resolved state is returned — which an agent would want before mutating review state.

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 0%, so the description must compensate. It meaningfully clarifies the ambiguous parameter, note, as a short user-facing message and gives two illustrative examples; however, comment_id is never explained (e.g., where to obtain it), so one of the two parameters remains undocumented.

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 and resource: marking a comment as handled, plus the side effect that a note is attached. That is clearer than a bare name restatement, though it does not explicitly differentiate from sibling actions like review_reply or review_finish.

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

Usage Guidelines2/5

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

No when-to-use or when-not-to-use guidance is given. The examples of note text imply the tool is used after addressing feedback, but an agent gets no rule for choosing this over review_reply or review_finish, and no mention of prerequisites such as the comment being open.

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

Deploy Server

Other Tools