Skip to main content
Glama

list_comments

Read-only

Retrieve a person's comments on document passages, with open comments shown by default, and filter results by open, done, or all to review feedback.

Instructions

The person's comments on passages (id, place, state, quote, text, heading, reply); open by default.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "list_comments"
  }
}

Input Schema

NameRequiredDescriptionDefault
whichNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changedv0.7.0
    • removedInput schema / $schema
      Removed value: -"https://json-schema.org/draft/2020-12/schema"
    • addedInput schema / additionalProperties
      Added value: +false
    • removedInput schema / properties / which / description
      Removed value: -"Which comments: `open` (the default), `done` or `all`."
    • addedInput schema / properties / which / enum
      Added value: +[
      +  "open",
      +  "done",
      +  "all"
      +]
    • changedInput schema / properties / which / type
      Previous value: -[
      -  "string",
      -  "null"
      -]New value: +"string"
  2. First observedv0.1.0

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds useful context by listing the returned fields and the default 'open' filter, but says nothing about pagination, ordering, or volume.

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?

A single compact sentence with the field list up front and the default stated at the end; every element is informative. Slightly telegraphic but not padded.

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 simple read-only list tool with no output schema, listing the returned fields is valuable and the default filter is stated. Only the relationship to resolve_comment is left unaddressed.

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 coverage is 0% for the single `which` enum (open/done/all). The description partially compensates by stating 'open by default', clarifying the default value, but it does not explain what 'done' or 'all' select semantically.

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?

The description states a specific verb+resource ('comments on passages') and enumerates the returned fields (id, place, state, quote, text, heading, reply), so an agent knows exactly what it gets. It does not distinguish itself from the related sibling resolve_comment, which is the main clarity gap.

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 phrase 'open by default' hints at the default filtering behavior, giving implied usage context. However, it never states when to use this versus resolve_comment or list_notes, nor any exclusions.

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