twdesk-list_helpdoc_sites

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is clear. The description adds useful context beyond annotations by explaining that help doc sites are knowledge bases and that the tool is meant for discovering site IDs, which aids understanding of the tool's role. No contradiction with 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?

Three short, front-loaded sentences: purpose, filter capability, and specific use case. Every sentence earns its place with no redundant information or filler.

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?

For a simple list tool with 7 pagination/filter parameters, the description covers the core purpose, filtering, and use case. The schema provides detailed parameter semantics, and the description implies the output contains site IDs. Minor gap: it does not mention the required-but-nullable parameter behavior, but this is visible in the schema.

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 baseline is 3. The description mentions filtering by name or subdomain, mirroring the 'name' and 'subdomain' parameters, but adds no new semantic detail beyond what the schema already provides, such as pagination quirks or null handling.

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 uses a specific verb ('List') and resource ('help doc sites') and clarifies they are knowledge bases. It distinguishes from sibling tools like twdesk-get_helpdoc_site and other twdesk-list_* tools by focusing on help doc sites. The added 'Use this to discover the site ID...' gives clear purpose.

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?

It explicitly states the primary use case: discovering the site ID required by help doc article tools. It also mentions filtering options, giving clear context for when to use this tool. However, it does not explicitly contrast with twdesk-get_helpdoc_site when the ID is already known, so no exclusions are stated.

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