Skip to main content
Glama

create_mail_account

Create an IMAP account for Paperless to connect to a mail server, enabling document ingestion from email via mail rules.

Instructions

Create an IMAP account for Paperless to fetch mail from. Nothing is fetched until a mail rule uses the account (create_mail_rule). Check the connection first with test_mail_account.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYes
ownerNo
is_tokenNotrue when `password` is an OAuth/app token
passwordYesIMAP password or OAuth token. Write-only: Paperless returns it masked as all asterisks (at least 10, one per character), and sending any all-asterisks value back leaves the stored password unchanged.
usernameYes
imap_portYesUsually 993 (SSL) or 143 (STARTTLS / none)
imap_serverYes
account_typeNo1=IMAP, 2=Gmail OAuth, 3=Outlook OAuth
character_setNoe.g. UTF-8 (default) or US-ASCII
imap_securityNo1=no encryption, 2=SSL, 3=STARTTLS

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv3.2.0

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already state readOnlyHint=false and destructiveHint=false, so the description is not required to repeat that. It adds useful behavioral context beyond annotations: the account is inert until a rule references it, and testing is recommended. This informs the agent of side effects (none immediate) and a recommended verification step. No contradiction with annotations.

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?

The description is two sentences with no filler. The primary action is front-loaded, and the additional context about mail rules and testing is concise and directly useful. Every word earns its place.

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 tool with 10 parameters and no output schema, the description is quite brief. It explains the tool's role in the mail pipeline but does not describe return values, error conditions, or parameter nuances beyond what the schema offers. Given the complexity, more guidance (e.g., expected response, duplicate handling) would improve completeness, but the existing context is not misleading.

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 60%, so several parameters (name, imap_server, username, owner, is_token, character_set) lack schema-level explanations. The description does not compensate for this gap; it mentions no parameters explicitly. However, the schema does document the key ones (password masking, port defaults, account_type, imap_security), so the description adds little value beyond what the schema already provides. Baseline 3 is appropriate given partial schema coverage.

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?

The description clearly states the specific verb-resource combination: 'Create an IMAP account for Paperless to fetch mail from.' It distinguishes this from sibling operations like update_mail_account, list_mail_accounts, and test_mail_account by focusing on the creation action and the account's purpose. The mention of related tools further clarifies its role in the mail workflow.

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?

The description provides clear context: it explains that no mail is fetched until a mail rule is created (create_mail_rule), and advises checking connectivity with test_mail_account first. This implicitly tells the agent when to use this tool (when setting up a new mail source) and gives a prerequisite step. It does not explicitly enumerate alternatives or exclusions, but the guidance is actionable and context-rich.

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