environment_reveal_variable

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

No annotations are provided, but the description discloses that the tool will fail unless the server is restarted with specific flags, and that it returns secret plaintext (implied by the warning about not calling it for other purposes). It also explains the required acknowledgment parameter.

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 paragraph that is somewhat repetitive. It front-loads the failure condition but could be more concise by separating the core purpose from the prerequisites.

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 tool has 4 required parameters and no output schema or annotations, the description is severely incomplete. It does not state the purpose, explain parameters, or describe the return value, leaving the agent with insufficient information to use the tool correctly.

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 has 4 required parameters with 0% description coverage. The description provides no explanation of what environmentId, name, reason, or acknowledgePlaintext represent or how to use them.

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 never states what the tool does. It only discusses its failure condition and provides workarounds. The name suggests 'reveal variable' but the description omits the core purpose.

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 advises not to call this tool if the secret can be consumed by a command/script, and suggests an alternative (op_script_run) with setup instructions. However, it does not clearly state when it is appropriate to use this tool (e.g., when plaintext reveal is enabled).

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