get_all_comments

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

With no annotations provided, the description must disclose behavioral traits, but it only states the action. Missing details on return format, pagination, order, or whether replies are included. For a read operation, basic transparency is insufficient.

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 very concise (4 words), which is efficient but at the cost of missing critical details. It is front-loaded but not informative enough.

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 no output schema, no annotations, and 0% schema coverage, the description is inadequate. A retrieving tool should indicate what the return value contains (e.g., list of comment objects) and any limitations.

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?

The schema has 0% coverage (no parameter descriptions), yet the description does not explain the sole parameter 'doc_id' at all. It should add meaning like 'doc_id is the document identifier' to compensate for the schema gap.

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 the verb 'get' and the resource 'document comments', indicating the tool retrieves all comments. However, it does not explicitly differentiate from sibling tools like 'get_comments_by_author' or 'get_comments_for_paragraph', which filter comments. The scope 'all' is implied but not emphasized.

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?

No guidance on when to use this tool versus alternatives. Since siblings exist for filtered comment retrieval, explicit usage context (e.g., 'Use this to fetch all comments without filters') would be helpful but is missing.

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