Skip to main content
Glama
Sign In
doc-review

doc-review

by MichaelEight
OverviewSchemaSourceRelated ServersDiscussionsAdmin
JavaScript
Local

review_threads

List document comment threads by file or status with their current anchor positions and messages to track and manage review feedback.

Instructions

List comment threads (all, or one file / status) with their current anchor position and messages.

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": "review_threads"
  }
}

Input Schema

NameRequiredDescriptionDefault
fileNo
rootNoAbsolute path of the workspace folder. Optional when only one workspace is open.
statusNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

B3.4/5.0
Behavior3/5

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

With no annotations supplied, the description must carry behavioral disclosure; 'List' does imply a safe read operation and the phrase 'with their current anchor position and messages' usefully describes result content. It omits ordering, pagination/limits, whether resolved threads appear by default, and any permission requirements, so gaps remain for an unannotated tool.

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 tightly worded sentence with the resource and scope front-loaded and no filler. Slightly dense parentheses make it marginally harder to parse, but nothing is wasted.

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 three-parameter, zero-required read tool with no annotations and no output schema, the description covers purpose and rough result shape. It stops short of the operational details an agent would want: default scope, ordering, and how the 'file' value should be formed.

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 only 33% (only the 'root' parameter is documented), so the description needs to compensate. It does clarify that 'file' and 'status' act as filters narrowing the listing and that no filter returns all, but it never explains the expected format of 'file' (path vs. identifier) or the effect of the status enum, leaving real ambiguity.

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 ('List comment threads') plus scope ('all, or one file / status') and hints at the return payload ('current anchor position and messages'). It does not explicitly contrast itself with siblings like review_open or review_resolve, but the read-only listing purpose is unambiguous.

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 parenthetical '(all, or one file / status)' implies the filtering options and that omitting filters returns everything, which is usable guidance. However, there is no explicit when-to-use or when-not-to-use statement and no mention of related siblings such as review_reply or review_resolve.

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