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

Annotations indicate read-only, non-destructive, idempotent behavior. The description adds valuable behavioral context beyond annotations: it describes the return format (category-bucketed example questions with exact tool+argument shape), the effect of calling with no arguments vs. a topic, and how it teaches usage of meta-tools.

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 front-loaded with the key question and examples, but it is somewhat verbose. Each sentence adds value for an onboarding tool, but could be slightly trimmed without losing clarity. Still well-structured.

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 tool's simplicity (one optional parameter, no output schema) and the presence of annotations, the description covers all necessary aspects: purpose, usage, input explanation, and return value. It is complete and leaves no gaps for the agent.

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 coverage is 100% with one parameter described. The description adds meaning by explaining the parameter's effect: 'Call with no arguments for the full spread, or pass `topic` (e.g. "finance", "pharma") to focus' and lists example values, going beyond the schema description.

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 specifies the tool's purpose as the onboarding entry point for learning what Pipeworx can do, returning category-bucketed example questions. It distinguishes itself from sibling tools like ask_pipeworx and discover_tools by explicitly stating its role and listing alternatives.

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 explicitly states when to use this tool ('Use this FIRST when you do not yet know what Pipeworx can do for you') and provides alternatives (ask_pipeworx, entity_profile, compare_entities). It also explains how to use the optional topic parameter to focus the response.

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