Skip to main content
Glama

search_documents

Read-only

Search Paperless-ngx titles and document text with query syntax; omit the query to browse recent documents. Filter by tag, correspondent, or document type, then page through results.

Instructions

Search titles and text with Paperless query syntax. Omit query to browse recent documents.

Filters use IDs from the list tools. Use next_page to continue. Results include metadata and links. Use read_document for the extracted text.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "search_documents"
  }
}

Input Schema

NameRequiredDescriptionDefault
pageNo
queryNo
tag_idNo
page_sizeNo
correspondent_idNo
document_type_idNo

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.9/5.0
Behavior4/5

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

readOnlyHint=true already covers the safety profile, so the description earns credit for the extras it adds: pagination continuation via next_page, that results carry metadata and links, and that the body text is deliberately excluded and requires read_document. Return format specifics are handled by the output schema.

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?

Four short sentences, front-loaded with the primary purpose and browse fallback before operational notes. Each sentence carries distinct information with no repetition.

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 six-parameter read tool with an output schema and a readOnly annotation, the definition covers purpose, defaults, pagination, ID sourcing, and the handoff to read_document. The remaining gap is parameter-level detail on paging, but the output schema and next_page reference largely compensate.

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 0%, so the description carries the burden, and it partially does: query is Paperless syntax and nullable, and the three filter parameters are sourced from the list tools. It says nothing about page_size, its 50 maximum, or how pagination interacts with next_page.

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?

Names a specific verb and resource ('Search titles and text') and adds the query dialect ('Paperless query syntax') plus the no-query browse behavior, which is real scope information. It explicitly differentiates from read_document but leaves the boundary with get_document implicit.

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

Usage Guidelines4/5

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

Gives concrete routing: omit the query to browse recent documents, pull filter IDs from the list tools, use next_page to continue, and switch to read_document for extracted text. It stops short of stating when-not-to-use this tool (e.g. when you already have a document ID), which keeps it below a 5.

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