Skip to main content
Glama

read_comments

Read-onlyIdempotent

List review comments on a survey's questions and blocks, with replies and resolved state, optionally for one question, block, or author. Comments on a question or block that was moved to Trash are kept (restoring it brings them back) and come back with anchor_in_trash: true; the editor hides them until then, and emptying Trash deletes them. Requires commenter access or higher.

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": {
      "survey_id": "<survey_id>"
    },
    "name": "read_comments"
  }
}

Input Schema

NameRequiredDescriptionDefault
user_idNoRestrict to comments authored by this collaborator
block_idNoRestrict to comments on a single block
survey_idYesSurvey UUID
question_idNoRestrict to comments on a single question

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior5/5

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

Annotations already establish read-only, idempotent, non-destructive, closed-world behavior, yet the description still adds material context: Trash retention semantics, the anchor_in_trash: true marker, editor-side hiding, that emptying Trash is what actually deletes comments, and the access level required. This is behavior an agent could not derive from the annotations or schema.

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?

The core purpose and scope lead, with the Trash caveat following as supporting detail; no filler sentences. The second sentence is dense with semicolons, which costs a little readability but every clause carries substantive information.

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 read-only listing tool with a fully documented schema and an output schema, the description covers the remaining gaps: access requirements and the non-obvious Trash/anchor_in_trash lifecycle. Nothing an agent needs in order to call it correctly or interpret results is missing.

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 100% and each parameter already documents its own restriction (author, single block, single question, survey UUID). The description restates those filters without adding format, precedence, or interaction details (e.g., whether question_id and block_id can be combined), so it matches the baseline for fully documented schemas.

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 review comments on a survey's questions and blocks', with scope qualifiers (replies, resolved state, optional filtering). It is clearly distinct from mutating siblings like edit_comment and delete_comment, but it never names a sibling to contrast against, so differentiation is by verb inference rather than explicit statement.

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 'Requires commenter access or higher' line gives a real prerequisite, and 'optionally for one question, block, or author' signals the narrowing options. However, there is no explicit when-to-use versus when-not guidance and no mention of alternatives such as edit_comment or delete_comment, and the filtering guidance largely restates the schema.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources