get_data_stream

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

With no annotations, the description must carry behavioral transparency. It correctly states the tool is read-only (retrieves info), explaining parameter behaviors like wildcard support and defaults. However, it does not address authorization, rate limits, or error conditions, leaving gaps in transparency.

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 the main purpose, then breaks into parameter details. It is efficient, uses clear language, and avoids redundancy. Minor wordiness (e.g., 'and other information') could be trimmed, but overall well-structured.

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 has an output schema, the description does not need to explain return values. It covers input parameters thoroughly, including wildcard and default behaviors. For a retrieval tool, this is complete enough, though additional details on pagination or sorting would strengthen it.

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 description coverage is 0%, so the description adds significant meaning. It explains the 'name' parameter accepts comma-separated lists or wildcards and defaults to all, and 'cluster' is optional with a default. This goes well beyond the schema's type-only definitions.

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 information about one or more data streams' and elaborates on retrieving configuration, mappings, settings. It explicitly distinguishes from siblings by focusing on read-only retrieval, contrasting with creation, deletion, and other operations.

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 implies usage for retrieving data stream information but does not provide explicit guidance on when to use this tool over siblings like get_alias, get_cluster_health, or get_index. No exclusions or alternative suggestions are given.

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