gha_optimize

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

With no annotations, the description carries the full burden, but it only states intent. It does not disclose whether the tool mutates the input, returns optimized YAML, requires an api_key, what the '(Pro)' suffix means operationally, or any side effects or failure behavior. This is thin for an optimization tool.

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?

A single sentence, front-loaded with the verb and resource, with no wasted words. The parenthetical 'Pro' is terse and conveys plan context. Every element earns its place.

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?

The tool has no output schema and no annotations, so the description should explain what the agent receives after the optimization and any prerequisites. It does not mention the return value, whether api_key is required for all calls, or what 'Pro' entails. For a transformation tool with three parameters, this is incomplete.

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 100%, so the baseline is 3. The description's 'speed and cost reduction' weakly maps to the optimize_for enum, but it adds no meaning beyond the schema's own parameter descriptions for workflow_yaml and api_key.

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?

States a specific verb ('Optimize'), resource ('GitHub Actions workflow'), and objective ('speed and cost reduction'). The '(Pro)' suffix adds plan/tier context. It distinguishes from siblings like gha_generate_workflow and gha_add_caching by focusing on whole-workflow optimization rather than creation or a specific enhancement.

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?

Usage is implied: you have a GitHub Actions workflow and want to optimize it. However, it does not explicitly say when to prefer this over alternatives such as gha_add_caching, gha_add_matrix, or make_optimize, nor does it state exclusions or prerequisites.

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