Get output settings

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

No annotations are provided, and the description simply restates the function without disclosing behavioral traits such as side effects, error behavior, or requirements. While a getter is likely side-effect free, this is not explicitly confirmed.

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 a single concise sentence that front-loads the action and resource, and immediately provides useful examples without any fluff.

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?

For a simple getter with one parameter and an existing output schema, this description is adequate. It lacks explicit usage guidance, but the examples and output schema cover the key information needed to invoke the tool correctly.

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?

The schema provides no description for output_name (0% coverage), but the description compensates with concrete examples (adv_stream, adv_file_output), clarifying the expected values. Though not exhaustive, the examples add meaningful guidance 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?

The description clearly states the tool retrieves settings for a specific OBS output, with concrete examples of valid outputs (adv_stream, adv_file_output). The verb 'Get' and resource 'settings' distinguish it from sibling tools like set_output_settings.

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 reading output settings but does not explicitly state when to use this tool versus alternatives. No mention of set_output_settings or other getters, but the examples provide context for which outputs to target.

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