List Newsletters

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

Annotations already declare readOnlyHint=true, so the agent knows it is safe. The description adds that it lists all newsletters for the org and can be filtered, but it does not disclose pagination behavior, rate limits, or return format. The added behavioral context is minimal beyond the annotations.

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, front-loaded sentence with no fluff. It directly states the main function and then the optional filter. Every word earns its place.

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 no output schema and moderate parameter count (3), the description should at least hint at the return format (e.g., list of newsletter objects). It also omits pagination details (defaults, max). It is adequate but leaves gaps for an agent to infer.

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 100%, so the description does not need to add much. It mentions the optional channelId filter, which mirrors the schema. It does not explain the page and limit parameters, but the schema already does. Thus, no added 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 verb 'List' and resource 'WhatsApp Channel newsletters,' making the purpose specific. It distinguishes from sibling tools that list other resources (e.g., channels, bots). However, it does not explicitly mention that the result is a paginated list, so slightly less than perfect.

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 for listing all newsletters with an optional filter, but it does not provide guidance on when to use this tool versus alternatives like get_newsletter (for a single item) or sync_newsletters (for syncing). No when-to-use or when-not-to-use advice is given.

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