hs4.intent.event_run_by_name

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

No annotations provided; description does not disclose behavior beyond basic action. Does not explain side effects, permissions, or what 'prepare' entails. The role of parameters like dryRun, confirm, and execute is unclear.

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?

Single sentence, concise but not very informative. Could be structured to separate resolve and commit phases for clarity.

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 7 parameters, no output schema, and no annotations, the description is incomplete. It does not explain the workflow, parameter interactions, error handling, or return values. Lacks context compared to sibling tools.

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?

With 0% schema description coverage, the description adds minimal meaning. Mentions 'by name/group' linking to query and groupHint, and 'prepare/optionally commit' relating to dryRun/execute, but does not explain each parameter's purpose or constraints.

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 it resolves an event by name/group and prepares or optionally commits execution. It distinguishes from sibling tools like 'hs4.events.run' and 'hs4.change.prepare' by combining resolve and commit, but the dual action could be confusing.

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 on when to use this tool vs alternatives like 'hs4.events.run' or 'hs4.change.commit'. Does not explain when to use dryRun vs execute or prerequisites.

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