Skip to main content
Glama

set_comment_status

DestructiveIdempotent

Resolve or reopen a review thread and confirm the resulting document revision. Requires the thread's anchor file path and edit or owner access on history-OT documents.

Instructions

Resolve or reopen a review thread and verify its resulting document revision. filePath must be the document the thread is anchored in, as list_comments reports it; a thread not anchored there fails with NOT_FOUND and nothing changes. On a history-OT document a status change needs owner or edit access: review-only or read-only access is PERMISSION_DENIED before anything is sent. Returns threadId, status, the resulting revision, trackChangesActive, writeMode, and recoveredAfterTimeout when a change that timed out, lost its socket, or could not be read back was confirmed by observation.

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>",
      "filePath": "<filePath>",
      "revision": "<revision>",
      "threadId": "<threadId>",
      "status": "<status>"
    },
    "name": "set_comment_status"
  }
}

Input Schema

NameRequiredDescriptionDefault
statusYes
filePathYesProject-relative path using forward slashes
revisionYesOpaque revision returned by a prior read or write
threadIdYes
projectIdYesOverleaf project ID

Output Schema

NameRequiredDescriptionDefault
statusYes
revisionYes
threadIdYes
writeModeYes
trackChangesActiveYes
recoveredAfterTimeoutNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.3.0

TDQS

A4.6/5.0
Behavior5/5

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

Beyond the idempotentHint/destructiveHint annotations, the description discloses the permission model (owner or edit access required on history-OT documents), that failures are pre-send and leave state unchanged, and the timeout/socket-loss recovery concept surfaced via recoveredAfterTimeout. These are behavioral traits an agent could not infer from the annotations alone.

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?

Front-loaded with the action and scope, then preconditions, then failure modes. It is dense but every clause carries operational meaning, though the final enumeration of return fields is partly redundant given that an output schema exists.

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

Completeness5/5

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

For a five-required-parameter mutation with an output schema, the description covers action semantics, path anchoring, authorization, failure behavior, and recovery verification. Nothing an agent needs in order to invoke it correctly appears to be missing.

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?

Schema coverage is 60%, and the description compensates by explaining that filePath must be the document the thread is anchored in (a constraint the schema only states as "Project-relative path") and by tying revision to a prior read or write and to the resulting revision. threadId and projectId remain undocumented beyond their schema entries.

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?

The description opens with a specific verb pair and resource: "Resolve or reopen a review thread and verify its resulting document revision." That distinguishes it from the comment-creation siblings (add_comment, reply_to_comment) and from list_comments, which it explicitly references as the source of filePath.

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 gives concrete preconditions and failure routing: filePath must be the anchoring document as list_comments reports it, otherwise NOT_FOUND with no change; on history-OT documents owner or edit access is required or PERMISSION_DENIED is returned before anything is sent. It does not explicitly name an alternative for related operations (e.g., adding versus resolving a comment), so routing is strong but not fully stated.

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