get_work_packages

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

No annotations provided; description fully carries burden. Discloses parallel fetching, per-item results, failed fetches don't stop batch, deduplication, select behavior (invalid name returns allowed set, always includes id/success/error), and size limit warnings.

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?

Well-structured with clear paragraphs covering purpose, behavior, parameter details, and warnings. Slightly verbose but front-loaded main purpose. Could use bullet points but effective.

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?

Covers batch behavior, error handling, deduplication, select behavior, and size limits. No output schema provided, but description mentions per-item result structure (id/success/error fields). Lacks explicit return format details, but sufficient for typical use.

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 0% but description adds detailed meaning: ids (internal vs display IDs, deduplication), select (field restriction, behavior with invalid name), and text_limit (prevent size limits). Significantly enhances schema understanding.

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?

Clearly states 'Get multiple work packages by ID in a single batch call.' Identifies verb, resource, and scope. Distinguishes from sibling tools like get_work_package (single) and search_work_packages (search methodology).

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 use (batch fetching by ID) and provides usage details: maximum 100 IDs, error handling, and proactive select/text_limit advice. Does not explicitly state when not to use, but context implies alternatives.

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