Skip to main content
Glama

update_workflow

Idempotent

Modify a single Paperless-NGX workflow (PATCH): change name, order, enabled, or replace triggers/actions. To edit one action, fetch the workflow first and send the full list.

Instructions

Update ONE workflow (PATCH). name/order/enabled change only when passed. ⚠️ triggers and actions, when passed, REPLACE the workflow's whole list: entries with an id update that existing item, entries without an id are created, and existing items you leave out are DELETED. To edit one action, call get_workflow first and send back the complete list with your change.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes
nameNo
orderNo
actionsNo
enabledNo
triggersNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed15 schema fields changedv3.2.1
    • changedInput schema / properties / triggers / items / properties / filter_custom_field_query / description
      Previous value: -"Custom-field filter as a JSON expression passed as a string. A condition is [field, operator, value], where field is the custom field's name or ID. Combine conditions with [\"AND\", [cond, …]] or [\"OR\", [cond, …]], and negate with [\"NOT\", cond]. Valid operators depend on the field's data type (e.g. exact, in, isnull, exists, icontains, gt, gte, lt, lte, range); pick an invalid one and Paperless names the valid ones. Examples: '[\"Amount\", \"gte\", 100]', '[\"AND\", [[\"Due\", \"lt\", \"2026-10-01\"], [\"Paid\", \"exact\", false]]]'."New value: +"Custom-field filter as a JSON expression passed as a string. A condition is [field, operator, value], where field is the custom field's name or ID. Combine conditions with [\"AND\", [cond, …]] or [\"OR\", [cond, …]], and negate with [\"NOT\", cond]. Valid operators depend on the field's data type (e.g. exact, in, isnull, exists, icontains, gt, gte, lt, lte, range); pick an invalid one and Paperless names the valid ones. Examples: '[\"Amount\", \"gte\", 100]', '[\"AND\", [[\"Due\", \"lt\", \"2026-10-01\"], [\"Paid\", \"exact\", false]]]'. Checked for types 2–4 (added, updated, scheduled) only — not at consumption start, when the document has no content or metadata yet."
    • changedInput schema / properties / triggers / items / properties / filter_filename / description
      Previous value: -"Filename pattern (whole name must match), * wildcards allowed"New value: +"Filename pattern (the whole name must match, case-insensitive), * wildcards allowed. Works for every trigger type: at consumption start it checks the incoming file's name, for types 2–4 the document's original file name."
    • changedInput schema / properties / triggers / items / properties / filter_has_all_tags / description
      Previous value: -"Document has ALL of these tags"New value: +"Document has ALL of these tags. Checked for types 2–4 (added, updated, scheduled) only — not at consumption start, when the document has no content or metadata yet."
    • changedInput schema / properties / triggers / items / properties / filter_has_any_correspondents / description
      Previous value: -"Correspondent is one of these"New value: +"Correspondent is one of these. Checked for types 2–4 (added, updated, scheduled) only — not at consumption start, when the document has no content or metadata yet."
    • changedInput schema / properties / triggers / items / properties / filter_has_any_document_types / description
      Previous value: -"Document type is one of these"New value: +"Document type is one of these. Checked for types 2–4 (added, updated, scheduled) only — not at consumption start, when the document has no content or metadata yet."
    • changedInput schema / properties / triggers / items / properties / filter_has_any_storage_paths / description
      Previous value: -"Storage path is one of these"New value: +"Storage path is one of these. Checked for types 2–4 (added, updated, scheduled) only — not at consumption start, when the document has no content or metadata yet."
    • changedInput schema / properties / triggers / items / properties / filter_has_not_correspondents / description
      Previous value: -"Correspondent is none of these"New value: +"Correspondent is none of these. Checked for types 2–4 (added, updated, scheduled) only — not at consumption start, when the document has no content or metadata yet."
    • changedInput schema / properties / triggers / items / properties / filter_has_not_document_types / description
      Previous value: -"Document type is none of these"New value: +"Document type is none of these. Checked for types 2–4 (added, updated, scheduled) only — not at consumption start, when the document has no content or metadata yet."
    • changedInput schema / properties / triggers / items / properties / filter_has_not_storage_paths / description
      Previous value: -"Storage path is none of these"New value: +"Storage path is none of these. Checked for types 2–4 (added, updated, scheduled) only — not at consumption start, when the document has no content or metadata yet."
    • changedInput schema / properties / triggers / items / properties / filter_has_not_tags / description
      Previous value: -"Document has NONE of these tags"New value: +"Document has NONE of these tags. Checked for types 2–4 (added, updated, scheduled) only — not at consumption start, when the document has no content or metadata yet."
    • changedInput schema / properties / triggers / items / properties / filter_has_tags / description
      Previous value: -"Document has ANY of these tags"New value: +"Document has ANY of these tags. Checked for types 2–4 (added, updated, scheduled) only — not at consumption start, when the document has no content or metadata yet."
    • changedInput schema / properties / triggers / items / properties / filter_mailrule / description
      Previous value: -"Only documents fetched by this mail rule ID"New value: +"Consumption-started (type 1) triggers only: only documents fetched by this mail rule ID"
    • changedInput schema / properties / triggers / items / properties / filter_path / description
      Previous value: -"Path pattern, * wildcards allowed"New value: +"Consumption-started (type 1) triggers only: consume-folder path pattern, * wildcards allowed"
    • changedInput schema / properties / triggers / items / properties / matching_algorithm / description
      Previous value: -"Content match for `match`: 0=none, 1=any word, 2=all words, 3=exact, 4=regular expression, 5=fuzzy word"New value: +"Content match for `match`: 0=none, 1=any word, 2=all words, 3=exact, 4=regular expression, 5=fuzzy word. Checked for types 2–4 (added, updated, scheduled) only — not at consumption start, when the document has no content or metadata yet."
    • changedInput schema / properties / triggers / items / properties / sources / description
      Previous value: -"Consumption sources: 1=consume folder, 2=API upload, 3=mail fetch, 4=web UI (default [1,2,3])"New value: +"Consumption-started (type 1) triggers only: consumption sources 1=consume folder, 2=API upload, 3=mail fetch, 4=web UI (default [1,2,3])"
  2. First observedv3.2.0

TDQS

A4.6/5.0
Behavior5/5

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

With readOnlyHint=false and destructiveHint=false already covering the top-level safety profile, the description adds the critical non-obvious behavior: passing `triggers`/`actions` REPLACES the whole list, id-bearing entries are updated, id-less entries are created, and omitted existing items are DELETED. It then tells the agent the concrete workaround (fetch via get_workflow first), which is exactly the 'what gets destroyed' context annotations cannot express.

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?

Four short sentences, front-loaded with the verb/scope, then the PATCH rule, then the destructive replacement warning, then the safe procedure. The warning marker and capitalization make the riskiest behavior scannable; nothing is padded.

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 deeply nested mutation tool with no output schema, it covers the highest-risk semantics (partial update, list replacement, deletion of omitted items) and a safe workflow. It stops short of stating permission/authorization requirements or whether omitting triggers/actions entirely leaves the existing lists untouched, leaving a small residual gap.

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?

Top-level schema description coverage is 0% (id/name/order/actions/enabled/triggers carry no descriptions), so the description has to carry the load: it defines PATCH semantics for name/order/enabled and, more importantly, the create-vs-update-vs-delete interpretation of entries in triggers/actions. The nested-item rules partially restate nested schema descriptions, but the omit-equals-delete semantics are unique to the 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 ('Update ONE workflow (PATCH)') and pins the scope to a single workflow, implicitly separating it from create/delete/list workflow and from the nested update_workflow_action / update_workflow_trigger siblings. The description also tells the agent that editing a single action is done through this tool after a get_workflow call, which further disambiguates it from the action-level tools.

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 clear invocation context: only passed fields (name/order/enabled) are modified, and it prescribes an explicit procedure ('call get_workflow first and send back the complete list with your change'). It doesn't spell out when-not to use it or name an alternative tool for the whole-workflow edit case, so it stops short of full when/when-not coverage.

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