delete_step

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

With no annotations, the description carries the full burden and does disclose the key traits: it is an explicit WRITE OPERATION, it requires a specific write scope, and it returns status='deleted'. It omits irreversibility/cascade behavior and idempotency, but the mutation and auth posture are stated.

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 lines, front-loaded with the action and scope, followed by the operation class and return value. No filler sentences.

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?

An output schema exists so return-value detail is unnecessary, and the description covers the write/auth posture. However, for a 3-required-parameter mutation with 0% schema coverage, the ambiguous id vs step_id semantics leave a real gap an agent could trip over.

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?

Schema description coverage is 0%, so the description must compensate, and it only partially does: the four entity types map loosely to entity_type, but it never clarifies the distinction between id and step_id, both of which are required integers. Two of the three parameters remain unexplained in both schema and prose.

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?

Names a precise verb (delete) and resource (step) and scopes it to four eLabFTW entity types, which cleanly separates it from update_step, toggle_step, add_step and list_steps by intent. It stops short of explicitly naming those siblings, so it is clear but not maximally differentiated.

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?

States a prerequisite (requires the step write scope), which is useful context, but gives no when-to-use guidance versus alternatives like toggle_step or update_step, and no conditions under which deletion should be avoided. Usage is only implied by the verb.

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