Skip to main content
Glama

delete_document_note

Permanently removes a single note from a Paperless-NGX document using its note ID; requires confirmation and returns the document's remaining notes.

Instructions

⚠️ DESTRUCTIVE: Permanently delete a single note from a document by its note ID. This operation is irreversible. Returns the document's remaining notes.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesThe document ID
confirmYesMust be true to confirm this destructive operation
note_idYesThe ID of the note to delete

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv2.2.1

TDQS

A4/5.0
Behavior4/5

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

With no annotations, the description carries the full behavioral burden and does well: it flags the operation as destructive, states it is permanent and irreversible, and discloses that the return value is the document's remaining notes. It does not mention permission/auth requirements, which is the remaining gap.

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?

Two tightly written sentences with the DESTRUCTIVE warning and irreversibility front-loaded, then the return value. No wasted words.

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

Completeness4/5

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

For a three-parameter destructive tool with no output schema, the description covers the safety profile, irreversibility, key parameter meaning, and return shape. Only a note about required permissions or a pointer to sibling list/bulk tools is missing.

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

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already documents id, note_id, and confirm. The description adds only that deletion targets a 'note' by 'note ID' and implies a document context, which is marginal added value. Baseline 3 applies.

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

Purpose5/5

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

States a specific verb (delete), resource (a single note on a document), and the lookup key (note ID). It is clearly distinguishable from siblings like list_document_notes and create_document_note.

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

Usage Guidelines3/5

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

Usage is implied by the destructive warning and the singular scope ('a single note'), but there is no explicit when-to-use vs alternatives guidance (e.g., to remove many notes use bulk_edit_documents, or to list notes first use list_document_notes). No exclusions or prerequisites stated.

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