Delete a data document from OPA

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

Annotations indicate destructiveHint=true, and the description confirms deletion with specifics. It adds behavioral details: response codes, path format, and root-path exclusion, which are beyond the annotations.

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?

Three sentences, no wasted words. The main action is front-loaded, and each sentence adds essential information (format, response, restriction).

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 a single required parameter, no output schema, and good annotations, the description fully covers what the tool does, how to use it, and key behaviors (responses, path restrictions).

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 only parameter 'path' has schema description at 100% coverage. The description adds value by clarifying dot/slash forms, min-length constraint, and exclusion of root-path deletion, enhancing the schema's meaning.

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 action ('Remove a document from OPA's data store') and the resource ('at the given path'). It distinguishes from sibling tools like opa_get_data or opa_put_data by specifying deletion and path format options.

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 the path format (dotted or slash), success/error responses (204 and 404 mapped to DATA_NOT_FOUND), and explicitly excludes root-path deletion. It does not directly compare to alternatives but provides sufficient context for use.

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