get_automation_api_log

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

No annotations are provided, so the description bears the full behavioral burden. It usefully discloses what the log records (every mutating/trigger operation across REST, WebSocket and service calls), but says nothing about return format (raw file text vs path), size/truncation behavior, or read-side safety profile.

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?

Two short sentences, the return target is front-loaded in the first, and the content enumeration follows. No filler, though the parenthetical filename is mildly redundant with the resource name.

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?

With no output schema and no annotations, the description should carry the return-value burden; it describes the log's contents but not its format, completeness, or size, leaving an agent unsure what it actually receives back.

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 tool takes zero parameters, so there is nothing for the description to disambiguate; the baseline for a parameterless tool applies.

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?

Clearly states a verb ('Return') and a specific resource (the automation_api.log file), then enumerates its contents (create/update/delete/trigger records via REST, WebSocket, service calls). It is unmistakably distinct from sibling tools such as get_automation or list_automations, though it never explicitly says so.

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?

There is no statement of when to reach for this tool versus alternatives (e.g. get_automation_yaml or get_history) or under what circumstances an agent would want the API log. Usage is only implied by the resource name.

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