Skip to main content
Glama

read_threaded_comments

Read all threaded comments in a workbook, including replies, authors, dates, and resolved status; retrieve comment IDs to reply to or resolve specific threads.

Instructions

Read all threaded comments in the workbook: content, author, creation date, resolved state, and replies. Use reply_to_comment or resolve_comment with a comment id from this output.

Input Schema

NameRequiredDescriptionDefault
workbookIdNoTarget workbook ID from list_workbooks. Optional when only one workbook is connected.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.6.0

TDQS

A4.2/5.0
Behavior4/5

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

No annotations are provided, so the description carries the full burden; it does so reasonably by disclosing the exact payload — including replies and resolved state — which tells the agent this is a non-mutating retrieval that surfaces both resolved and unresolved threads. It does not mention permission requirements or behavior when the workbook has no comments, leaving a small gap.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences with zero filler: the first front-loads scope and return fields, the second front-loads the follow-up action. Nothing redundant or buried.

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 single-optional-parameter read tool with no output schema and no annotations, the description supplies the return shape and the next-step integration, which is most of what an agent needs. Minor gaps remain around empty results and whether the whole thread history or only the current state is returned.

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?

The single parameter workbookId has 100% schema description coverage (including the note that it is optional when one workbook is connected), so the schema already does the work. The description only refers obliquely to 'the workbook' and adds no new parameter meaning.

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?

States a specific verb ('Read') and resource ('all threaded comments in the workbook') and enumerates the returned fields (content, author, creation date, resolved state, replies), which distinguishes it from the sibling add_comment and from the Word-oriented read_comments. An agent can tell exactly what it gets back without opening a schema.

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?

The second sentence gives explicit downstream workflow: use reply_to_comment or resolve_comment with a comment id taken from this output. That is clear context for why and when to call it, but it offers no exclusions (e.g. how it relates to read_comments or what to do if no workbook is connected).

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