list_document_enum_options

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

Discloses the fallback behavior for unknown document_type, which is beyond the readOnlyHint annotation. No contradictions 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 clear, front-loaded sentences. No fluff, every sentence adds value.

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 listing tool with an output schema, the description covers purpose, usage guidelines, and a behavioral nuance. It is complete given the tool's complexity.

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 provides descriptions for most parameters (field_id, project_id, document_type) covering 60% of parameters. The description adds critical context about document_type fallback and pre-write usage. Pagination params are standard, so the description adds value without over-explaining.

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 clarifies the scope ('valid enum option ids for a document field of a given type'). It distinguishes from siblings like list_work_item_enum_options by specifying 'document field'.

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?

Explicitly states when to call this tool ('before create_document / update_document') and warns about invalid enum IDs being rejected. Also provides a caveat about unknown document_type falling back to '~'.

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