list_reference_docs

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

No annotations provided. Description indicates a read-only list operation but does not explicitly state read-only, nor disclose any constraints like pagination, rate limits, or idempotency. For a simple list, this is adequate but not thorough.

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?

Single sentence of 14 words, front-loaded with key information. No redundant or unnecessary content; highly efficient.

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 parameters and no output schema, the description covers the essential behavior and return fields. However, it does not address possible pagination or the distinction from 'list_deleted_reference_docs', which is a minor gap.

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?

No parameters exist, and schema coverage is 100% (empty). Baseline for zero parameters is 4. Description correctly implies no input needed, adding no extra parameter info.

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?

Description clearly states the verb 'List all', resource 'reference docs', and scope 'in your Axonity tenant', with return fields in parentheses. Distinguishes from sibling tools like 'read_reference_doc' and 'list_deleted_reference_docs'.

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?

Implied usage for listing non-deleted reference docs, but no explicit when-to-use or when-not-to-use statements. Alternatives like 'list_deleted_reference_docs' exist but are not referenced.

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