telemetry_query

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

No annotations provided, so description carries burden. Says it returns latest values for subscribed paths and requires subscription, but does not detail behavior like blocking, error cases, or what happens if no subscription exists.

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?

Two sentences plus a bullet-style argument list. Front-loaded with main action, no redundant phrases. Every sentence earns its place.

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 a simple tool with one param and existing output schema, description covers purpose, prerequisite, and parameter meaning. Could mention error cases or subscription status, but is mostly 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?

With 0% schema coverage, description adds critical meaning: 'Name of the device as defined in devices.yaml' clarifies the parameter's source and format. Adds value beyond the 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?

Clearly states the action (query), resource (telemetry data for a device), and scope (latest values for all subscribed paths). Distinguishes from siblings like telemetry_history by specifying 'latest' and requiring a prior subscription.

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?

Explicitly mentions prerequisite 'Start a subscription first with telemetry_subscribe.' Provides clear context for when to use, though lacks explicit when-not-to-use or alternatives beyond the prerequisite.

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