Idm Get Streams

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

With no annotations, the description carries the full behavioral burden. 'List' implies a safe read and the de-duplication rule across devices sharing a connection port is a genuine behavioral disclosure beyond the schema. However, it says nothing about permissions, result size, or whether the listing is live or cached.

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 short sentences with zero filler. The primary purpose is front-loaded and the de-duplication caveat follows it naturally.

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?

An output schema exists, so return values needn't be explained, and the one optional parameter is fully covered by the schema. The definition is nearly complete for a simple filtered list; only the relationship to idm_read_stream is left unstated.

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%, and the single optional 'device' parameter is fully documented in the schema (root, name or substring; omit for all). The description adds no parameter detail, so the baseline 3 applies.

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?

States a specific verb and resource ('List the TCP streams the gateway exposes') and adds the shape of the result ('with their names'). The de-duplication clause further defines scope, though it never names the confusable sibling idm_read_stream, which an agent must disambiguate on its own.

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?

No when-to-use or when-not guidance. The agent is not told to call this instead of idm_read_stream when it wants metadata rather than stream content, nor when to prefer idm_get_protocols or idm_list_connections. Usage must be inferred from the name alone.

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