generate_github_workflow

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

With no annotations provided, the description must carry the full burden of behavioral disclosure. It states capabilities (supports custom name, stack, deploy target) but does not disclose the output format (e.g., returns YAML string), side effects (if any), or prerequisites (e.g., GitHub repo existence). The term 'production-ready' hints at quality but not at behavior. This leaves the agent guessing about what happens when the tool is invoked.

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 two sentences long, front-loads the primary action, and includes the supported options without any fluff. Every word contributes to the purpose. It is appropriately concise and structured for quick comprehension.

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?

For a tool with no output schema and no annotations, the description should clarify what the tool returns (likely YAML content) and any usage constraints. It mentions deploy targets but does not describe the output or any side effects. The tool is simple, so a complete description would mention that it returns the workflow YAML. This omission prevents it from being fully complete.

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?

The input schema covers 100% of parameters, each with a description, so the baseline is 3. The description lists 'custom name, stack, and deploy target' but this merely restates the parameters without adding semantic depth. It does not explain parameter interactions, defaults beyond what schema states, or formatting requirements. The description adds marginal value over the schema.

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 action: 'Generate a production-ready GitHub Actions CI/CD workflow YAML.' The verb 'Generate' and resource 'GitHub Actions CI/CD workflow YAML' are specific, and the mention of 'Supports custom name, stack, and deploy target' distinguishes it from sibling tools like check_cicd (which checks rather than generates) and generate_starter_repo (which generates a broader repo).

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 gives no explicit guidance on when to use this tool versus alternatives. It does not mention any conditions, exclusions, or contrast with sibling tools such as check_cicd or generate_starter_repo. Usage is only implied by the name and purpose, which is insufficient for an agent to make routing decisions.

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