Stop EDL Logging

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

With annotations declaring readOnlyHint=false and destructiveHint=false, the description usefully adds that the file is finalized and that a markers EDL is produced only when markers were added, which explains conditional side effects. It also discloses the return payload (file paths for Resolve import). Minor gap: no note on behavior when stopping with no active session.

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 clauses with zero waste: the action comes first, the conditional markers detail and the return value follow. Nothing to trim and nothing buried.

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 zero-parameter tool with no output schema, the description covers the action, the side effects, the conditional markers file, and what is returned (file paths). An agent has everything needed to call it 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?

Zero parameters, so there is nothing for the description to disambiguate; baseline applies. The absence of a session-id or path argument is worth understanding, but that is a schema fact, not a description gap.

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?

States a specific verb and resource ('Stop EDL logging'), plus the concrete outcome of finalizing the .edl file. This is clearly distinguished from atem_edl_start and atem_edl_marker by the 'stop/finalize' framing, though it does not name those siblings explicitly.

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?

Usage is implied: call this to end an EDL logging session and produce an importable file. There is no explicit statement of prerequisites (e.g. that atem_edl_start must have been called) or what to do if no session is active, and no alternatives are named.

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