gha_add_caching

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

No annotations are provided, so the description carries the full behavioral disclosure burden. 'Add' implies a non-destructive, additive modification, which is useful, but the description does not disclose that an api_key is needed for authentication, whether it edits a workflow file in place, what happens if caching steps already exist, or what the tool returns. For a mutation tool with zero annotation coverage, this is a meaningful gap.

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 12-word sentence that leads with the action verb, states the target resource, and closes with the purpose. Every word earns its place; there is no filler or redundancy.

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 simple 3-parameter tool with full schema coverage, the description covers the core action adequately. However, with no output schema and no annotations, it should have disclosed at least the precondition (an existing workflow to modify), the authentication requirement implied by api_key, and the expected effect — none of which are present. These omissions leave an agent guessing about prerequisites and outcomes.

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 schema already documents all three parameters (api_key, language, cache_paths) with clear descriptions. The tool description adds no parameter-level meaning beyond the schema, so the baseline 3 applies. The 'language' parameter's role in the caching strategy is only hinted at through the example values in 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 names a specific verb ('Add'), a precise resource ('caching steps to a GitHub Actions workflow'), and the motivating outcome ('for faster builds'). This clearly differentiates it from siblings like gha_generate_workflow, gha_add_matrix, and the other caching tools (http_add_caching, proxy_add_caching, qbatch_add_caching) because the GitHub Actions scope is explicit.

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 usage context is implied: an existing GitHub Actions workflow should be present to receive caching steps, and caching is for speeding up builds. However, the description never names alternatives or exclusions — e.g., when to use gha_generate_workflow or gha_optimize instead, or whether this tool should be run before or after workflow generation.

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