Get defect metadata

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

With no annotations, the description carries the behavioral disclosure burden. It clearly indicates a read-only metadata retrieval operation and explains the conditional behavior based on `kind`. It does not discuss authentication or output shape, but those are not critical for a simple metadata fetcher.

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?

Two short sentences, no filler, with the main purpose front-loaded and the parameter behavior following immediately. Every sentence earns its place.

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 tool is simple: one optional parameter, no output schema, no nested objects. The description covers the invocation variants and enumerates what will be returned, which is sufficient for a correct call. A more explicit return format would be nice, but nothing essential is missing.

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% and the schema already documents `kind` with an enum and a default of all. The description adds value by explicitly explaining the behavioral difference between passing a kind and omitting it, reinforcing and slightly extending the schema.

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 opens with a specific verb and resource, 'Get the available defect statuses, severities, priorities, issue types and environments,' and enumerates exactly what the tool returns. This clearly distinguishes it from sibling tools like list_defects or get_test_run_metadata.

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 gives explicit usage instructions: pass `kind` for a single list or omit it for all five. It does not name alternatives, but no alternative sibling provides the same metadata, so the guidance is clear enough for when to use it.

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