# Nutrient Workflow MCP

> Nutrient Workflow lets you build document workflows directly into your applications. Your AI client interacts with its tools—like `list_processes` or `start_request`—to manage complex business processes, handle approvals, and track status changes via natural conversation. It embeds PDF viewing, editing, annotation, and digital signatures right where you need them.

## Overview
- **Category:** document-management
- **Price:** Free
- **Tags:** workflow-automation, process-control, document-processing, low-code, request-management, business-process-management

## Description

Don't gotta click through a web portal to manage your business processes; your AI client handles it using natural conversation. This server lets you build complex document workflows right into your applications.

**Understanding the Tools**

*   To see every workflow available, call `list_processes` to list all published process definitions. You can then use `get_process` if you need the deep configuration details for a specific workflow type.
*   Need to kick off a new request? Use `start_request`; it'll trigger a brand new instance of any configured workflow and give you a unique ID for tracking.

**Checking Status and History**

*   To get an overview of all current or historical requests, run `list_requests`. If you need the full status and metadata on one specific request, pull that info with `get_request`.
*   If a process stalls because someone needs to sign off, your agent can check what tasks are pending for any user using `list_user_tasks`, or get detailed information about just one task via `get_task`.

**Advancing the Workflow**

*   When you're ready to move things along, you use `complete_task`. This tool advances a workflow instance by completing any pending task, and it requires you to submit all necessary form data—like an approval signature or required inputs—in one go.

**Managing the System**

*   You can audit who's using the system by running `list_users` to retrieve the full list of registered tenants. To see what reports are available, use `list_reports`, which returns a list of templates and what inputs they require. These tools let you manage everything from initial process discovery and request tracking all the way through task completion.

## Tools

### complete_task
Advances a workflow instance by completing a pending task, requiring specific form data to proceed.

### get_process
Retrieves the full configuration details for a specified workflow process type.

### get_request
Gets all status and metadata for one specific, active request instance.

### get_task
Retrieves the details of a single pending task within a workflow.

### list_processes
Lists all available, published process definitions that can be used for automation.

### list_reports
Returns a list of available reporting templates and their required inputs.

### list_requests
Retrieves a summary list of all current or historical workflow requests.

### list_user_tasks
Lists all pending tasks assigned to a specific user ID, showing exactly what they need to action next.

### list_users
Retrieves the full list of registered users within your organization's tenant.

### start_request
Kicks off a brand new instance of a workflow, creating a unique request ID for tracking.

## Prompt Examples

**Prompt:** 
```
List all active workflow processes.
```

**Response:** 
```
I've fetched your processes. You have 5 active workflows, including 'Expense Approval', 'Onboarding', and 'IT Support Ticket'.
```

**Prompt:** 
```
Find pending tasks for user 'admin_123'.
```

**Response:** 
```
User 'admin_123' has 3 pending tasks: 2 Expense Approvals and 1 Budget Review. Would you like the details for the first one?
```

**Prompt:** 
```
Start a new 'Expense Approval' request.
```

**Response:** 
```
Request started! I've triggered a new instance of the 'Expense Approval' workflow. The new Request ID is 'req_777'.
```

## Capabilities

### View all available workflows
The agent lists every published workflow process so you can see what types of business operations are supported.

### Start a new document request
Your AI client triggers a brand new instance of any configured workflow, generating a unique ID for tracking.

### Check process and request status
The agent retrieves detailed metadata on entire processes or specific requests to understand their current state and history.

### Advance the workflow with a task completion
You use `complete_task` to programmatically move a request forward, submitting necessary data (like approval signatures) in one go.

### Monitor system users and reports
The server lists registered tenants and available report types, letting you audit the overall health of your workflow management system.

## Use Cases

### The Expense Approval Bottleneck
Finance ops needs to know if an expense report is stuck. Instead of checking the main portal, they ask their agent: 'What tasks are pending for John Doe?' The agent calls `list_user_tasks`, finds two items, and tells them exactly which one—a budget review—needs attention.

### New Employee Onboarding
An HR manager needs to kick off a new employee's onboarding. They tell their agent: 'Start the Acme Corp onboarding process.' The agent uses `start_request`, creating a unique request ID and triggering all necessary departmental steps automatically.

### Auditing System Access
The security team needs to audit who has access. They prompt their agent: 'List all registered users.' The agent uses `list_users` to get a full roster, ensuring compliance checks are immediate and traceable.

### Updating Workflow Rules
A process analyst wants to see the rules for PTO requests. They ask the agent to 'Show me the details for the PTO workflow.' The agent calls `get_process` to retrieve the specific configuration metadata, allowing the analyst to verify the steps.

## Benefits

- **Instant Status Checks:** Stop guessing where a request is. Use `list_requests` or `get_request` to immediately pull the status of any workflow, eliminating manual dashboard checks.
- **Targeted Task Management:** Need to know who's stuck? Call `list_user_tasks`. Your agent shows exactly which user has pending actions, letting you follow up instantly instead of searching multiple inboxes.
- **Automated Process Launch:** Starting a new document flow is simple. Using `start_request` kicks off the entire process—be it an expense report or PTO request—with one command and a unique ID.
- **Deep System Visibility:** Use `list_processes` to see every workflow definition available, and then use `get_process` if you need to verify specific metadata about how that workflow is configured.
- **Full Audit Trail:** The server handles the entire lifecycle. You can monitor all activities using `list_users` and find out who has access to what data.

## How It Works

The bottom line is: it turns complex, multi-step business processes into simple conversational commands for your agent.

1. Subscribe to the Nutrient Workflow server. Then, enter your Tenant ID, Host, and API Key from your company’s settings.
2. Your agent uses natural conversation (e.g., 'Start a new PTO request'). The client sends the command to the MCP Server.
3. The server executes the necessary tool calls (`start_request` or `list_processes`) and returns structured data that your AI client reads and presents to you.

## Frequently Asked Questions

**How do I find out which workflows are available on Nutrient Workflow MCP Server?**
Call the `list_processes` tool. This immediately returns a list of all published workflow definitions (like 'Expense Approval' or 'Onboarding'), letting you see exactly what processes your agent can run.

**Can I force an approval using complete_task?**
Yes, `complete_task` advances the request state. You must provide all required form data (like signatures or justifications) for that task to succeed; otherwise, the process stops.

**What is the difference between get_request and list_requests?**
Use `list_requests` when you want a high-level overview of several requests (e.g., 'Show me all pending payrolls'). Use `get_request` when you have an ID and need the full, detailed status history for just that one item.

**Does Nutrient Workflow MCP Server help with user permissions?**
Yes. You can use `list_users` to get a roster of all registered users in your tenant, helping you audit who has access and what roles exist within the system.

**When I run `get_task`, what kind of failure or error data can I retrieve?**
The response provides complete execution logs, including specific stack traces and detailed messages. You get to see exactly which step failed—whether it was due to bad form data, a system timeout, or an invalid user ID.

**What information do I need to provide when using `start_request`?**
The tool requires mandatory parameters defined by the specific workflow's schema. You must supply all necessary inputs, such as department names or required dates, otherwise, the request will fail before it even begins.

**Besides just listing processes, what kind of data can I get using `get_process`?**
You retrieve detailed configuration metadata for a workflow. This includes the process's version history, associated roles, and the full blueprint showing every required step in the process flow.

**What does the `list_reports` tool tell me about my organization’s data?**
It provides a list of all available report names and their associated metadata. This tells your AI client which dashboards or key performance indicators are ready to be pulled into your agent workflow for analysis.

**Can I list all my business processes using my AI agent?**
Yes! Use the `list_processes` tool to retrieve a full list of all published workflow processes in your tenant.

**How do I start a new workflow request through this integration?**
Simply provide the Process ID to the `start_request` tool. You can also pass initial form data as a JSON object.

**Is it possible to complete a task via the AI agent?**
Yes, use the `complete_task` action. Provide the Task ID and any required form data to progress the workflow.