Read Bruno Environment

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

With no annotations, the description takes on full responsibility for behavioral disclosure. It reveals that secret variables are returned by name only because Bruno stores no value for them, and it clarifies that the return is structured JSON with specific flags. This is non-obvious context that prepares the agent for actual output.

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 concise, using three sentences that explicitly state the purpose, the alternate usage, and an important edge case. Every sentence contributes information without redundancy, making it easy to parse and act on.

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 simplicity and the lack of an output schema, the description adequately explains what is returned and the special handling of secrets. It could potentially mention error cases or the exact JSON shape, but it is complete enough for the intended use, especially considering the schema's 100% coverage.

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 schema already provides thorough descriptions for both parameters, including the meaning of 'name' and the effect of omitting it. The description adds only a note about secrets, which is more about return behavior than parameter semantics. Thus, it meets the baseline without adding significant parameter-specific value.

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 reads an environment and returns structured JSON with all variables, disabled and secret flags. It additionally notes that omitting 'name' lists environments, which helps distinguish it from sibling tools like read_request or list_collections.

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 provides clear guidance on the optional name parameter, explaining that omitting it lists environments instead. It also explains the secret variable behavior, which is useful for avoiding confusion. While it doesn't explicitly name alternative tools, the usage context is sufficiently clear.

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