Skip to main content
Glama

list_comments

Read-only

Retrieve review comment threads and their document positions from an Overleaf project, filtered by status, author, or file, to inspect open feedback before editing.

Instructions

List review comment threads and lazily resolve their document positions. Defaults to open threads. author keeps threads with a message whose author display name contains it (case-insensitive) or whose author id equals it. Returns threads, each with id, status, messages (id, author { id, displayName } or null, content, ISO timestamp), resolvedAt and resolvedBy when resolved, and when located filePath, start, end (1-based line, UTF-16 column), and quotedText; a thread without a document range has unlocated: true. Without filePath, positionsUnavailable: true means the deployment has no project-wide range index and every thread is unlocated.

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": {
      "projectId": "<projectId>"
    },
    "name": "list_comments"
  }
}

Input Schema

NameRequiredDescriptionDefault
authorNoAuthor display name substring, or exact author id
statusNoopen
filePathNoOnly threads anchored in this document
projectIdYesOverleaf project ID

Output Schema

NameRequiredDescriptionDefault
threadsYes
positionsUnavailableYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.3.0

TDQS

A4.1/5.0
Behavior4/5

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

Annotations only declare readOnlyHint=true, and the description adds genuinely new behavioral facts: positions are resolved lazily, a thread lacking a range is marked unlocated, and positionsUnavailable signals a deployment without a project-wide range index. That deployment-level caveat is the kind of context annotations cannot convey; only the omission of any cost/latency note for lazy resolution keeps it from a 5.

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 default are front-loaded, and the dense enumeration of returned fields is informative rather than padded. It is long and sentence-heavy, and the return-shape enumeration partly duplicates the output schema, but no clause is purely filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a four-parameter read tool with an output schema and readOnlyHint, the description covers scope, filtering semantics, and the tricky deployment-dependent behavior. It is essentially complete; a brief note on whether lazy resolution costs extra calls would close the remaining gap.

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?

With 75% schema coverage the schema already documents all four parameters, yet the description adds real semantics: the author match is a case-insensitive display-name substring OR an exact author id, and the absence of filePath changes the result shape via positionsUnavailable. These clarify matching rules and cross-parameter effects rather than restating the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Opens with a specific verb and resource ('List review comment threads') plus a distinctive behavior ('lazily resolve their document positions'), which cleanly separates it from sibling mutators like add_comment, reply_to_comment, and set_comment_status.

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 states the default scope ('Defaults to open threads') and how the author filter behaves, which implies when to use it, but it never names an alternative tool or says when not to use this one (e.g., versus set_comment_status or a search tool). Usage is inferable rather than explicit.

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