gha_generate_workflow

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

No annotations are provided, so the description carries the full disclosure burden. It only states what the tool produces, not how it behaves: whether it returns YAML text, writes a file to the repository, overwrites an existing workflow, requires GitHub authentication via api_key, or makes external API calls. The presence of an api_key parameter hints at unspecified behavior the description fails to explain. No contradiction with annotations since none exist.

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, front-loaded sentence with zero filler: the verb, resource, and two key content areas are packed efficiently. Every word earns its place, and there is nothing extraneous to cut.

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 no annotations and no output schema, the description leaves meaningful gaps: the return value or destination of the generated YAML, the role of api_key, and how a 'schedule' trigger is configured given no cron parameter exists in the schema. The rich input schema covers parameters, but an agent cannot fully predict the call's outcome or side effects.

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% — every parameter (workflow_name, trigger, language, branch, api_key) is documented in the schema with a description and the trigger parameter has an enum. Per the baseline rule for high coverage, the description need not repeat parameter details; it adds marginal value by mentioning 'triggers and jobs' but no deeper semantics.

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 states a specific verb ('Generate') with a clear resource ('GitHub Actions workflow YAML') and names its key contents ('triggers and jobs'). This differentiates it from sibling gha_ tools such as gha_add_caching, gha_add_matrix, and gha_optimize, which extend or modify existing workflows rather than creating one from scratch.

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 guidance is given on when to use this tool versus alternatives. The sibling set contains gha_add_caching, gha_add_matrix, and gha_optimize, and the description never states the boundary, e.g., 'use this to create a new workflow, use gha_add_* to extend an existing one.' An agent must infer the usage context entirely.

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