get_work_items

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

No annotations provided, so description carries full burden. It implies a read-only batch operation with full field data, but does not disclose rate limits, pagination, batch size constraints, or authentication requirements. Lack of behavioral detail beyond basic function.

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?

Description is concise (one sentence + args list), front-loaded with the primary purpose. Every sentence adds value with no redundancy. Structured with clear parameter references in args format.

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 output schema existing, return format is covered. However, for a batch tool, missing info on maximum batch size, error handling for invalid IDs, or behavior when items not found. Adequate for basic use but gaps for robust selection.

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 description coverage is 0%, so description must clarify parameters. It provides brief but helpful definitions: project name, work_item_ids as numeric list, working_directory as optional path. Adds meaning beyond schema types and required status.

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?

Description clearly states 'Batch-fetch multiple work items by ID with full field data,' specifying verb (batch-fetch), resource (work items by ID), and scope. Distinguishes from siblings like get_work_item (single) and query_work_items (query-based).

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 explicit guidance on when to use this tool versus alternatives. While purpose suggests batch use, it does not mention when to prefer get_work_item for single items or query_work_items for filtering. Missing exclusions or context.

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