jira_component_list

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

No annotations are provided, so the description carries the full burden. It does disclose that the tool returns YAML, which is useful, but it does not state that the operation is read-only (though 'List' implies it), nor does it describe pagination, output structure, or any side effects. The mention of a mirrored CLI command is obscure and not helpful without additional context.

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 concise and front-loaded with the key purpose, followed by output format and a reference. It uses three short sentences with no redundant information, making it easy to parse quickly.

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?

This is a simple tool with one parameter, but there is no output schema. The description states that the output is YAML but does not explain what the YAML contains, which could leave the agent uncertain about the response structure. It also omits error cases or prerequisites, but for a basic listing operation, the description is minimally adequate.

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 input schema covers the one required parameter 'project' with a clear description ('Project key (e.g., `PROJ`)'). The tool description adds no extra meaning about the parameter beyond what the schema already provides, so the baseline of 3 is appropriate.

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's function: 'List a JIRA project's components.' This is a specific verb+resource combination that distinguishes it from sibling tools like jira_component_create, jira_component_update, and jira_component_delete, which all suggest mutating operations.

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 implies the tool is for listing components in a JIRA project, but it does not explicitly mention when to use it over alternatives. It lacks any exclusions or comparisons with sibling list tools (e.g., jira_board_list, jira_version_list). The reference to mirroring a CLI command does not provide tool-selection guidance.

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