Skip to main content
Glama

list_comments

List comments in a workspace. Filter by target_type (row, cell, doc_range, html_element, surface, workspace), target_id, surface (returns every comment anchored to any element of one surface, useful for 'open threads on this surface'), status (open | resolved | all, default open), mentioning_me: true for comments that @-mention the caller, or author: <principalId> for comments by a specific user/agent. Returns up to 200 comments per call ordered by createdAt asc, with surfaceSlug denormalized for doc_range/html_element/surface targets so reply paths work even across archive boundaries. Use get_comment_thread to pull a single comment plus its replies + reactions.

Input Schema

NameRequiredDescriptionDefault
slugYesThe workspace slug.
limitNoMax results (1-200, default 50).
authorNoFilter by author principal id. Useful for 'comments by Argus on this workspace' agent loops.
offsetNoNumber of comments to skip for pagination.
statusNoResolution state filter. Default `open`.
surfaceNoSurface slug filter. Returns every comment anchored anywhere inside this surface (doc_range / html_element / surface scope, plus row + cell comments on rows that live on the surface). 404 silently if the surface is archived (returns empty list).
target_idNoFilter by exact target id. For cells the id is `<rowId>:<columnKey>`; for doc_range/html_element/surface it's the Surface cuid. Combine with target_type for unambiguous filtering.
target_typeNoFilter by comment target type.
mentioning_meNoWhen true, only return comments that @-mention the calling principal. Equivalent to REST `?mentioning=me`.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / target_type / enum
      Previous value: -[
      -  "row",
      -  "cell",
      -  "doc_range",
      -  "html_element",
      -  "surface",
      -  "workspace"
      -]New value: +[
      +  "row",
      +  "cell",
      +  "doc_range",
      +  "html_element",
      +  "video_frame",
      +  "surface",
      +  "workspace"
      +]
  2. Added
  3. Removed
  4. Added

TDQS

A4.1/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 burden and does disclose real behavioral traits: a 200-comment cap per call, ordering by createdAt asc, surfaceSlug denormalization for reply paths, and the default status of open. It does not mention auth/permission requirements or how offset/limit interact with the cap, which keeps it out of 5 territory.

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?

One dense paragraph that is front-loaded with purpose and the sibling route at the end. Every clause carries filter semantics, though the packing of six filters plus return behavior into a single block makes it slightly harder to scan than a short bulleted or sentence-segmented form.

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?

With no output schema, the description compensates by stating the result cap, sort order, and the denormalized surfaceSlug field — enough for an agent to reason about the response. Pagination mechanics (offset) are only covered by the schema, leaving a minor gap for a 9-parameter list tool.

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%, so the schema already documents all nine parameters with equivalent detail. The description largely restates the enum values and defaults rather than adding syntax or semantics the schema lacks. Baseline 3 is appropriate when structured fields do the heavy lifting.

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+resource ("List comments in a workspace") and immediately scopes the tool with the full filter vocabulary. It explicitly differentiates itself from the sibling get_comment_thread, so an agent can route between the two without opening either 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?

Names the alternative tool (get_comment_thread) and the condition that selects it ("to pull a single comment plus its replies + reactions"), and gives concrete use cases per filter ("open threads on this surface", "comments by Argus on this workspace"). It stops short of explicit when-not-to-use guidance beyond the single alternative, so it falls just short of a 5.

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.