Skip to main content
Glama

list_comments

Retrieve board comments, optionally filtered by file or unresolved status, to review design feedback and track open issues.

Instructions

List board comments (docs/design/comments.json), optionally for one file or only unresolved ones.

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
fileNo
unresolvedNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.6/5.0
Behavior3/5

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

No annotations are provided, so the description carries the burden; 'List' reasonably conveys a read-only operation and it usefully points to the underlying file. However, it says nothing about permissions, ordering, volume, or what a returned comment looks like.

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?

A single front-loaded sentence with the core action first and the optional modifiers after; no padding or redundancy.

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

Completeness3/5

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

For a two-optional-param read tool with no output schema and no annotations, the definition is minimally viable but leaves gaps: the return shape, comment fields, and ordering are unstated, which an agent may need to interpret results.

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?

With 0% schema coverage, the description is the only source of parameter meaning, and it does cover both: 'for one file' maps to the file param and 'only unresolved ones' maps to the unresolved boolean. It stops short of clarifying whether file is a path, name, or id.

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 board comments') and even discloses the backing store (docs/design/comments.json). It is clearly distinguishable from mutating siblings like add_comment or resolve_comment, though it does not explicitly name them.

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 optional filters imply the main usage contexts (per-file listing, unresolved-only triage), but there is no explicit when-to-use or when-to-prefer-alternatives guidance relative to resolve_comment or reply_comment.

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