environment_reveal_variable

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

No annotations are provided, so the description carries full burden. It clearly states that the tool will fail unless the server is restarted with specific flags, and implies it returns plaintext secret. However, it lacks details on success behavior, authentication, or side effects.

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 lengthy and rambling, mixing failure conditions with alternative tool suggestions. It is not concise and buries the key information about the tool's inability to function.

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's sensitive nature (revealing secrets), the description fails to cover proper usage, parameter meanings, return format, and success behavior. It is completely inadequate for an agent to correctly invoke the tool.

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 0%. The description does not mention any of the four parameters (environmentId, name, reason, acknowledgePlaintext), leaving the agent without guidance on what values to provide.

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 does not state what the tool does; it only mentions that it will fail due to server configuration. The name implies revealing a variable, but the text provides no explicit 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 gives a 'when-not' guideline (do not call if secret is for command/script) and suggests alternatives, but does not specify when the tool should be used. It focuses on failure conditions rather than proper usage.

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