list_work_items

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

Discloses that leading wildcards are rejected, module and body text are not Lucene-indexed, and advises using SQL via get_sql_query_recipes. Annotations already state readOnlyHint=true, consistent.

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 sentences pack essential information, but second sentence is dense with multiple pieces of guidance. Still efficient and front-loaded.

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?

Given output schema exists, description covers behavior, limitations, and alternatives comprehensively. No gaps apparent.

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?

Adds context beyond schema for query parameter (e.g., module/body text not indexed) but schema already describes query types. Other parameters not elaborated, but schema coverage is 50%.

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 the tool lists/searches work items in a project, distinguishes from get_work_item for single item and mentions read_document_parts as alternative for scope.

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 says when not to use (e.g., for one known id) and provides guidance on query types (avoid leading wildcards, use get_sql_query_recipes before hand-writing SQL).

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