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

Annotations already declare readOnlyHint, openWorldHint, idempotentHint, destructiveHint, and the description adds valuable behavioral context: it is the onboarding entry point that returns live catalog examples with exact tool shapes. No contradictions.

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 thorough and well-structured, starting with aliases and examples, then detailing the return format and usage. Slightly verbose but all sentences add value; could be more concise without losing clarity.

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, the description fully explains the return value (category-bucketed example questions with tools+arguments). It covers all aspects: topics, call patterns, and the meta-tools. Complete for a tool with one optional parameter and rich annotations.

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 optional parameter. The description adds significant meaning by listing possible topic values (e.g., 'finance', 'pharma'), explaining that omitting topic gives full spread, and providing context for usage.

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 explicitly states the tool returns category-bucketed example questions with tool+argument shapes, and positions it as the onboarding entry point when the agent doesn't know Pipeworx's capabilities. It clearly distinguishes from siblings by its specific purpose and usage context.

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 provides explicit guidance: 'Use this FIRST when you do not yet know what Pipeworx can do for you'. It explains when to use it (onboarding, getting ideas) and mentions alternatives like ask_pipeworx, entity_profile, compare_entities. Also specifies calling with/without arguments.

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