Get Environment Health

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

Annotations already declare readOnlyHint, idempotentHint, and non-destructive behavior. The description adds valuable context: it paginates through all nodes and runs, and may be slow on large environments. No contradiction with annotations.

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 front-loaded with purpose and behavior, followed by a detailed return structure. It is efficient but the return block is lengthy; still, it earns its place by documenting the output.

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 rich annotations and output schema, the description covers purpose, behavioral traits (pagination, latency), and a detailed return format. It is comprehensive for a health dashboard 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 coverage is 100% for the single parameter environmentID, so the description's parameter info adds little beyond the schema. However, the description also shows the full return structure, which indirectly adds context. Baseline 3 is appropriate.

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 'Get a comprehensive health dashboard for a deployed environment' with a specific verb and resource. It distinguishes itself from siblings by noting it composes multiple API calls, setting it apart from simpler getters like get_environment or get_environment_overview.

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 explains when to use it (for a comprehensive health summary) and includes a caveat about pagination and potential delays on large environments. However, it does not explicitly state when not to use it or list alternatives, though the behavior note provides practical guidance.

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