jira_get_sprint_issues

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

No annotations provided, so description must fully disclose behavior. Claims 'all issues' but max_results defaults to 50, implying pagination. No mention of returned fields, sorting, or rate limits. Misleading without 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?

Single sentence is concise but omits critical details (pagination, parameter roles), reducing effectiveness. Does not earn its place due to incomplete information.

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 3 parameters, no output schema, and no annotations, the description is incomplete. Fails to explain pagination, default results, or common use cases, leaving agents uninformed.

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 67%; description adds no parameter explanation beyond schema. For instance, max_results is not described in schema or description, so agents may not understand its effect.

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 retrieves issues in a sprint ('Get all issues in a sprint.'). It differentiates from siblings like jira_get_board_issues (board-level) and jira_search_issues (custom JQL), but fails to clarify that 'all' is limited by max_results.

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?

No guidance on when to use this tool versus alternatives such as jira_get_board_issues or jira_search_issues. Missing prerequisites (e.g., sprint_id must be obtained from sprint listing) or limitations.

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