ruddur_search_headings

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

Annotations already convey read-only, idempotent, open-world, and non-destructive behavior. The description adds the authentication scope requirement and the 'creator-owned' scoping constraint, which are useful beyond annotations. No contradiction.

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 focused on the action and resource. It is concise with no wasted words, aside from a minor double-space typo.

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?

The description covers auth and basic query usage but omits response format, pagination, or any details about what is returned. Since there is no output schema, the description should provide more context about results.

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 only generic body and query objects, but the description names the specific query parameter 'q', which is essential for usage. It does not elaborate on the body parameter, but for a search tool, 'q' is the critical semantic detail.

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 searches creator-owned Headings using query parameter q, with a specific verb and resource. It does not explicitly differentiate from ruddur_list_headings, but 'search' implies a distinct action.

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 is provided on when to use this tool versus alternatives like list_headings or get_heading. It only states the action and a required scope, leaving the agent without context on selection.

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