Skip to main content
Glama
cubinet-code

paperless-ngx-mcp

by cubinet-code
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

search_documents

Read-only

Search Paperless documents with ranked full-text queries across content, titles, and metadata; supports advanced syntax, plain text, or title-only modes.

Instructions

Ranked full-text search through Paperless's search index (content, title and metadata). mode 'query' (default) takes advanced syntax — AND/OR/NOT, "quoted phrases", field:value, wildcards*; 'text' takes plain words with no syntax; 'title' searches titles only. The index is updated in the background and can lag behind or miss documents: if you expect matches but get none, use list_documents with search, which scans the database directly. For filtering by tag, correspondent, type or date use list_documents. Content is excluded from results; use get_document_content.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
modeNoquery = advanced syntax (default), text = plain words, title = titles only
queryYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv3.2.1
    • addedInput schema / properties / mode
      Added value: +{
+  "description": "query = advanced syntax (default), text = plain words, title = titles only",
+  "enum": [
+    "query",
+    "text",
+    "title"
+  ],
+  "type": "string"
+}
  2. First observedv3.2.0

TDQS

A4.5/5.0
Behavior4/5

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

Annotations only declare readOnlyHint, so the description carries the real burden and does it well: it discloses that the index is updated in the background and can lag or miss documents, and that content is excluded from results. Missing only result-limit/pagination behavior.

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

Conciseness4/5

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

Dense but every clause is load-bearing: mode semantics, index-lag caveat with fallback, filtering alternative, and content-exclusion pointer. Slightly packed, but the search operation and its scope are front-loaded.

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?

With no output schema, the description sensibly notes that content is excluded and where to get it, and warns about index staleness. Complete enough to call correctly, with only return-shape/paging details left out.

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

Parameters4/5

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

Schema coverage is 50% and the required `query` param has no schema description, but the description compensates by explaining the syntax each mode accepts (AND/OR/NOT, quoted phrases, field:value, wildcards) and pinning 'query' as the default. It adds real meaning beyond the enum schema description.

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 and resource (ranked full-text search over the Paperless index) and immediately scopes what is searched (content, title, metadata). It cleanly distinguishes itself from list_documents and get_document_content by naming them.

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

Usage Guidelines5/5

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

Explicit routing: use list_documents with `search` when the index lags or misses documents, use list_documents for tag/correspondent/type/date filtering, and get_document_content to retrieve content. When-to-use and when-not-to-use are both covered.

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

Deploy Server

Other Tools