servicebus_peek_subscription_dlq_to_file

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

No annotations provided, so description carries full burden. It clearly states the tool is non-destructive, describes output format (JSON keyed by sequence number), metadata returned (dead letter reason, error description, sequence number, enqueue time), and auth mechanism (connection string or DefaultAzureCredential). Missing details like file overwrite behavior, but sufficient for a peek tool.

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 with 5 sentences, front-loaded with the main purpose. No redundant information, each sentence adds value. Well-structured and readable.

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 6 parameters, 4 required, and an output schema, the description covers the main action, output format, auth, and metadata returned. It does not explain handling of empty DLQ or file overwrite, but for a peek tool it is mostly complete. The output schema exists, so return values are covered.

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 description adds meaning. It explains connection_string_env_var behavior and output_file format. However, other parameters (namespace, topic, subscription, max_count) are not elaborated beyond their names. The description implies their roles through the main action, but more detail on max_count would help.

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 verb 'peek', the resource 'dead letter queue for a topic subscription', and the specific action of saving message bodies to a file. It distinguishes from sibling tools like servicebus_peek_subscription_dlq (no file output) and servicebus_peek_dlq_to_file (queue vs 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?

The description mentions 'non-destructively peek', implying use for investigation. It specifies saving bodies to file and returning metadata in context. While it does not explicitly state when not to use or list alternatives, the context of siblings like servicebus_peek_subscription_dlq and servicebus_peek_subscription_messages_to_file allows inference. A small gap for explicit exclusions.

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