Skip to main content
Glama

get_workflow_action

Read-only

Retrieve a specific workflow action by ID to inspect its configuration and details in Paperless-NGX.

Instructions

Get a specific workflow action by ID.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv3.2.0

TDQS

A3.8/5.0
Behavior2/5

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

The description's 'Get' aligns with the readOnlyHint=true annotation, but it adds no behavioral context beyond that annotation. It does not mention authentication, response format, potential errors, or confirm that no modifications occur, so it fails to disclose anything additional.

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 a single seven-word sentence with the verb and resource front-loaded. It contains no filler and is appropriately sized for a straightforward getter.

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 simple single-parameter read tool with a readOnly annotation, the description covers the essential calling contract: pass the ID. It does not describe the return shape, but with no output schema the resource name 'workflow action' sufficiently implies the response object, so nothing critical is missing.

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 description coverage is 0%, so the description must clarify the `id` parameter's role, and it does: 'by ID' indicates the required number identifies the workflow action to fetch. For a single-parameter tool, this is adequate, though it does not elaborate on ID source or format beyond the schema's type.

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 uses a clear verb ('Get') and resource ('workflow action'), with 'specific ... by ID' establishing a single-item scope. This distinguishes it from sibling tools such as list_workflow_actions (batch retrieval) and create/update/delete variations.

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

Usage Guidelines3/5

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

The phrase 'specific ... by ID' implies this is for fetching a single workflow action when its ID is known, but there is no explicit guidance on when to prefer it over list_workflow_actions or mention of exclusions. The usage context is only implied, not stated.

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