broadcast_custom_event

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

The description discloses that the event is broadcast to all subscribed clients, which is a clear behavioral trait. However, it does not mention any side effects, error conditions, or that the payload is constrained to an object, and with no annotations the description carries full burden. It is adequate but minimal.

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 only two sentences and front-loads the core purpose. The Args section is minimal and to the point. No unnecessary words or repetition.

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 one-parameter broadcast tool, the description plus schema are nearly sufficient. However, since there is no output schema, the description does not explain what the client can expect as a response or if any errors might occur. It covers the core behavior but leaves some gaps for a complete invocation.

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 description adds meaning to 'event_data' by calling it an 'arbitrary JSON payload delivered to receivers,' which goes beyond the schema's bare type definition. However, the word 'arbitrary' is slightly misleading because the schema requires an object, not any JSON value. It provides partial clarification but not complete precision.

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 action ('Broadcast a CustomEvent') and the target ('all subscribed obs-websocket clients'). This is a specific verb+resource that distinguishes it from the many siblings dealing with inputs, scenes, or transitions.

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 guidance is provided on when to use this tool versus alternatives, nor any exclusions or prerequisites. The description only states what it does, leaving the agent to infer its place among the large sibling list.

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