Skip to main content
Glama
pvliesdonk
by pvliesdonk

Delete Document Note

delete_document_note
DestructiveIdempotent

Remove a specific note from a Paperless document using its document ID and note ID, ensuring notes stay accurate.

Instructions

Remove a note from a document.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
note_idYes
document_idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.1

TDQS

B3.1/5.0
Behavior3/5

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

Annotations already declare destructiveHint=true and idempotentHint=true, covering the safety profile. The description adds no extra behavioral context beyond 'remove', which is consistent with the annotations. It does not disclose side effects like permanence or cascading effects, but given the annotations, the minimal statement is adequate.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single, short sentence that gets straight to the point with zero filler. The core action is front-loaded and there is no redundant phrasing.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple two-parameter deletion tool, the description is minimal but workable. However, it lacks usage context and parameter elaboration, and does not mention expected behavior when the note does not exist or whether deletion is permanent. The output schema (though not shown) and annotations cover some gaps, but the description alone leaves an agent guessing about edge cases.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

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. It only says 'a note from a document' without elaborating on the two parameters (document_id, note_id) or their relationships. The parameter names are self-explanatory, but the description adds no semantic value beyond what the schema already conveys.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description 'Remove a note from a document' clearly identifies the action (remove) and the resource (a note within a document). It is specific enough to distinguish from sibling tools like delete_document (whole document) and delete_document_type (type), though it does not explicitly name them.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description gives no guidance on when to use this tool versus alternatives. It does not mention prerequisites, context, or situations where a different delete operation would be more appropriate. An agent must infer usage from the name alone.

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