Stream App Metrics

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

The description goes beyond the readOnlyHint annotation by explaining that `network` and `requestsPerSec` are null on the first sample, and that streaming emits frames every five seconds and never completes on its own. This is valuable behavioral detail not present in the 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 concise and well-structured, using just two sentences to convey both the one-shot behavior and the streaming alternative. No unnecessary words or repetition; every sentence adds value.

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?

The description covers the key operational aspects: the default one-shot read, the null fields on first sample, and the streaming option with its interval and non-terminating nature. It does not specify the output format or schema, but given the simplicity of the operation and the absence of an output schema, the description is largely complete.

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 description provides no explanation of the parameters (env, region, appSlug, workspaceSlug), and the schema itself has zero description coverage. The agent is left to infer the meaning from parameter names alone, which is insufficient given the lack of any parameter-level guidance in either the description or schema.

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's purpose: it returns app metrics readings, with the ability to stream live usage via an Accept header. This distinguishes it from other streaming tools like streamAppStatus or streamDeployLogs by focusing on metrics data.

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 specific usage guidance by explaining the one-shot vs. streaming behavior and mentioning the Accept: text/event-stream header for live streaming. It does not explicitly contrast with alternative tools, but the name and context make the intended use clear.

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