github_actions_update_environment_variable

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

No annotations provided, and the description does not disclose behavioral details (e.g., partial vs full update, required authentication, or what the 'body' parameter expects). The schema shows a nested 'body' object, but the description offers no explanation.

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, which is concise for a straightforward action. However, it could benefit from a bit more structure, such as listing key parameters or required context.

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 presence of a nested 'body' parameter, no output schema, and no annotations, the description is insufficient. It fails to explain the update semantics (e.g., field-level update vs replacement) or what the response looks like.

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 coverage is 100%, and parameter descriptions are minimal (only the parameter names). The description adds no additional meaning beyond the schema. The 'body' parameter lacks detail on allowed properties.

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 indicates it updates an environment variable, but it does not differentiate from sibling tools that update other variable types (e.g., org, repo). The verb 'update' and resource 'environment variable' are specific, yet the lack of scope detail weakens clarity.

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 on when to use this tool versus alternatives like 'create_environment_variable' or 'delete_environment_variable'. No context about prerequisites or limitations.

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