comments_list

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

Annotations already provide readOnlyHint=true, destructiveHint=false, and idempotentHint=true. The description adds that the operation is read-only and returns the full Voog comment shape, which complements the annotations without contradiction.

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

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

The description is two concise sentences: the first states the purpose and endpoint, the second lists return fields and a usage hint. No redundant or unnecessary text.

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

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

Given the annotations (read-only, destructive, idempotent) and the description of return shape, the tool is well-documented for a simple list operation. No output schema exists, but the description compensates by listing return fields. Site parameter could have more context, but overall adequate.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 50%: only article_id has a description ('Voog article id (from articles_list)'), which the description reiterates. The site parameter lacks schema description and is not explained further, so the description adds limited value beyond the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states 'List comments on an article' with the specific endpoint, and explicitly lists the return fields, making the purpose unmistakable. It also distinguishes from sibling tools like comment_delete and comment_toggle_spam.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description advises using article_id from articles_list, which is a helpful usage hint. However, it does not explicitly state when not to use this tool or mention alternatives, though the read-only hint and sibling tools provide implicit guidance.

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