servicebus_peek_subscription_messages_to_file

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

Discloses non-destructive peeking, file writing, metadata return, and auth mechanism (connection_string_env_var or DefaultAzureCredential). Missing details on whether output_file is overwritten or appended, and no mention of max_count behavior or error handling.

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?

Description is concise with three short paragraphs, front-loaded with purpose. No redundant information, though some details could be integrated more efficiently.

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?

Covers core functionality and auth, but lacks details on parameter behaviors (e.g., session_id, max_count) and output_file handling. Output schema exists, which partially compensates, but the description could still be more thorough.

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?

Only one parameter (connection_string_env_var) is explained in the description. The other six parameters (namespace, topic, subscription, output_file, max_count, session_id) have no description, so the description adds minimal value beyond the schema for most parameters.

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 peeks at messages from a Service Bus topic subscription and saves bodies to a file, using specific verb and resource. However, it does not explicitly differentiate from sibling tools like servicebus_peek_subscription_messages, though the file-saving aspect is evident.

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 explicit guidance on when to use this tool versus alternatives. The description implies use for saving message bodies to a file but does not mention when not to use it or provide comparative context with related peek tools.

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