Server Configuration
Describes the environment variables required to run the server.
Name | Required | Description | Default |
---|---|---|---|
PAPERLESS_URL | Yes | URL of your Paperless-NGX instance | http://your-paperless-instance:8000 |
PAPERLESS_API_KEY | Yes | API token for your Paperless-NGX instance |
Schema
Prompts
Interactive templates invoked by user choice
Name | Description |
---|---|
No prompts |
Resources
Contextual data attached and managed by the client
Name | Description |
---|---|
No resources |
Tools
Functions exposed to the LLM to take actions
Name | Description |
---|---|
bulk_edit_documents | - |
post_document | - |
list_documents | List and filter documents by fields such as title, correspondent, document type, tag, storage path, creation date, and more. IMPORTANT: For queries like 'the last 3 contributions' or when searching by tag, correspondent, document type, or storage path, you should FIRST use the relevant tool (e.g., 'list_tags', 'list_correspondents', 'list_document_types', 'list_storage_paths') to find the correct ID, and then use that ID as a filter here. Only use the 'search' argument for free-text search when no specific field applies. Using the correct ID filter will yield much more accurate results. |
get_document | - |
search_documents | Full text search for documents. This tool is for searching document content, title, and metadata using a full text query. For general document listing or filtering by fields, use 'list_documents' instead. |
download_document | - |
list_tags | List all tags. IMPORTANT: When a user query may refer to a tag or document type, you should fetch all tags and all document types up front (with a large enough page_size), cache them for the session, and search locally for matches by name or slug before making further API calls. This reduces redundant requests and handles ambiguity between tags and document types efficiently. |
create_tag | - |
update_tag | - |
delete_tag | - |
bulk_edit_tags | - |
list_correspondents | - |
get_correspondent | - |
create_correspondent | - |
update_correspondent | - |
delete_correspondent | - |
bulk_edit_correspondents | - |
list_document_types | List all document types. IMPORTANT: When a user query may refer to a document type or tag, you should fetch all document types and all tags up front (with a large enough page_size), cache them for the session, and search locally for matches by name or slug before making further API calls. This reduces redundant requests and handles ambiguity between tags and document types efficiently. |
get_document_type | - |
create_document_type | - |
update_document_type | - |
delete_document_type | - |
bulk_edit_document_types | - |