List Document Comments

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

Annotations already declare readOnlyHint, openWorldHint, idempotentHint, and destructiveHint, so the description only adds the max_comments limiting behavior. It does not disclose any other behavioral traits such as pagination, sorting, or whether resolved comments are included.

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 a single concise sentence that front-loads the primary purpose (list all comments) and includes the optional parameter. Every word earns its place with no redundancy.

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?

With a simple tool, annotations, and an output schema, the description is minimally complete but lacks details like whether comments include resolved ones, pagination behavior, or any filtering. It does not fully leverage the context, leaving some ambiguity about the return set.

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 0%, so the description must compensate. It explains max_comments as a limit on results, but does not clarify document_id or user_google_email, although their names are somewhat self-explanatory. 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 the tool lists all comments from a Google Document, specifying the resource (Google Document) and the action (list). This distinguishes it from sibling tools like list_spreadsheet_comments and manage_document_comment.

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 implies usage by stating the tool lists comments and mentions an optional limit using max_comments, but it does not explicitly state when to use this tool versus alternatives or any exclusion criteria. No alternatives are referenced.

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