Skip to main content
Glama

list_comments

Read-only

Retrieve comments left on Markdown document passages with quoted text, location, and state, so you can review or address feedback; filter by open, done, or all.

Instructions

The comments the person left in TrailMark on passages of the project's Markdown documents ("this contradicts section 2", "simplify"). Each has an id, the document path, the quoted passage, its heading path and line, the comment text, when it was made, and state: anchored when the quote is still in the document (the line is where it is now), passageChanged when the passage was rewritten (the line is the best guess) or documentGone. Open comments by default; pass which = done or all for others. Call this when the person asks you to go through, address or apply their comments on the documents. A warning says when the comments file could not be read, which is why the list is empty. Also works when TrailMark is closed, from the project's files.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
whichNoWhich comments: `open` (the default), `done` or `all`.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.4/5.0
Behavior5/5

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

Annotations only cover readOnlyHint, and the description adds substantial context beyond them: the meaning of each `state` value (anchored/passageChanged/documentGone) and what the line number means in each case, the `warning` field explaining an empty list, and the fact it works with TrailMark closed.

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?

Dense but front-loaded with the resource and its fields, then state semantics, then usage trigger, then the warning caveat. Slightly list-like in enumerating output fields, but with no output schema that content earns its place.

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?

With no output schema, the description fully documents the returned fields and the meaning of the state enum, plus failure behavior and offline operation. An agent has everything needed to call and interpret this tool correctly.

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 the schema text for `which` ('open (the default), done or all') is essentially identical to the description's restatement. Baseline 3 is appropriate since the schema already carries the parameter semantics and the description adds no new syntax or format detail.

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+resource (comments the person left) with precise scope: passages of the project's Markdown documents, illustrated with example quotes. It is immediately distinguishable from siblings like list_notes, list_tags, and resolve_comment.

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?

Gives a clear triggering condition ('Call this when the person asks you to go through, address or apply their comments') and explains the default filter plus how to change it via `which`. It does not explicitly name the alternative (resolve_comment) or state when not to use this tool, so 4 rather than 5.

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