hs4.events.get

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

The description mentions the inclusion of raw definition fields conditionally, which adds behavioral context. However, with no annotations provided, it fails to disclose whether the operation is read-only, requires authentication, or has any side effects. The agent is left uncertain about safety and error conditions.

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, 16-word sentence that efficiently conveys the core purpose and a key behavior. Every word adds value, and there is no redundancy.

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 get tool with 4 parameters and no output schema, the description covers the main functionality. However, it lacks details on parameter options (e.g., what happens if both id and group/name are supplied), error handling, and the structure of the response. This is adequate but not 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?

The description adds meaning to id, name, and group as lookup keys, and hints at includeRaw via 'raw definition fields when available.' However, it does not explicitly explain the includeRaw parameter or its default value. With 0% schema coverage, the description should fully compensate but falls short.

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 a single HS4 event by id or exact group+name, and includes raw definition fields when available. This is specific and distinguishes it from sibling tools like hs4.events.list, hs4.events.definition.get, and hs4.events.run.

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 explains that the event can be fetched by id or by combination of group and name, which gives agents two clear methods. However, it does not explicitly state when to prefer one over the other or when alternatives (e.g., hs4.events.list) are better suited.

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