Portfolio Delivery Overview

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint, which align with the description. The description adds behavioral context by specifying the output is a summary of 'delivery health' and 'top risk hotspots,' which is beyond what annotations provide.

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 a single sentence that efficiently conveys the core purpose and scope without unnecessary words. It is front-loaded and easy to parse.

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 the tool's complexity (8 parameters, no output schema), the description is too brief. It fails to explain aggregation logic, what 'risk hotspots' means, output format details, or how parameters affect behavior. More context is needed for effective 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 description coverage is 0%. The description implicitly explains scope_type and project_ids by mentioning 'group or an explicit set of projects,' but it does not explain other parameters such as per_page, output_format, project_limit, pipeline_limit, or stale_after_days. This is insufficient for a tool with 8 parameters.

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 purpose using specific verbs and resources: 'Summarize delivery health across a group or an explicit set of projects and highlight the top risk hotspots.' It distinguishes itself from sibling tools by focusing on aggregation and risk spotlight.

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 mentions the scope types (group or projects) but does not provide explicit guidance on when to use this tool versus alternatives like gitlab_get_group_delivery_overview or gitlab_summarize_project_status. No exclusion criteria or prerequisite context is given.

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