Nintex MCP Tools
Important: Nintex MCP is currently in beta. For more information, see the Nintex Beta terms document.
MCP tools let an MCP-compatible client work with Nintex data and actions, such as tasks, tables, solutions, users, groups, workflows, workflow instances, and forms. The tools available depend on your Nintex role and permissions. Tools that you are not authorized to use are not shown in your MCP client.
Tool access
- Some tools can update or delete Nintex data.
-
Review the action before confirming. Completed, deleted, or started actions cannot be undone.
The following table lists the MCP tools available for Nintex and the minimum role required to use each tool.
| Category | Tool name | Tool label | Minimum role | Description |
|---|---|---|---|---|
| Identity | whoami | Whoami | Participant |
Shows the signed-in user's identity, tenant, and role information for the current MCP session. |
| Tasks | tasks_list_assigned | List assigned tasks | Participant | Lists workflow tasks assigned to a specific user. |
| tasks_list | List tasks | Participant | Lists tasks across all assignees for management and oversight. | |
| tasks_get | Get a task | Participant | Shows details for a specific workflow task, including valid outcomes. | |
| tasks_complete | Complete a task | Participant | Completes a workflow task by selecting an allowed outcome. This action cannot be undone. | |
| tasks_delegate | Delegate a task assignment | Participant | Delegates a workflow task assignment to one or more users so they can act on the task. | |
| tasks_autodelegations_list | List automatic task delegations | Participant | Lists automatic task delegations for workflow tasks. | |
| tasks_autodelegations_create | Create an automatic task delegation | Participant | Creates an automatic task delegation to assign workflow tasks to delegates during a specified period. | |
| tasks_autodelegations_update | Update an automatic task delegation | Participant | Updates the settings for an automatic task delegation. | |
| tasks_autodelegations_delete | Delete an automatic task delegation | Participant | Deletes an automatic task delegation. This action cannot be undone. | |
| Tables | tables_list | List Nintex tables | Participant | Lists tables in the current tenant. |
| tables_get |
Get a Nintex table by ID |
Participant | Shows metadata for a specific table. | |
| tables_get_schema | Get a table's column definitions | Participant | Shows the column definitions for a table, including field names, data types, and required fields. | |
| tables_create | Create a Nintex table | Designer | Creates a table with its initial columns and optional tags. Tables created using MCP can only be deleted from the Nintex Tables. | |
| tables_add_column | Add a column to a Nintex table | Designer | Adds a column to an existing table. Columns added using MCP can only be removed from the Nintex Tables. | |
| tables_set_display_column | Set a Nintex table's display column | Designer | Sets an eligible column as the display column for an existing table. The display column is used to identify records when they are referenced, including in Relationship columns. | |
| tables_query_records | Query records from a Nintex table | Participant | Queries records from a table. | |
| tables_aggregate_records | Aggregate records (count, sum, group by) | Participant | Calculates counts, sums, averages, minimum and maximum values, and grouped results for table records. | |
| tables_add_record | Add a record to a Nintex table | Participant | Adds a record to a table. | |
| tables_get_record | Get a record from a Nintex table | Participant | Gets a single record from a table by ID. | |
| tables_update_record | Update a record in a Nintex table | Participant | Updates a single record in a table by ID. | |
| tables_delete_record | Delete a record from a Nintex table | Participant | Soft-deletes a single record from a table by ID. The record is hidden immediately and can be restored during the retention period. The default retention period is 30 days. | |
| Solutions | solutions_list | List Nintex solutions | Designer | Lists Nintex solutions available to the signed-in user. |
| solutions_get | Get a Nintex solution by ID | Designer | Shows metadata for a specific Nintex solution, including its description and asset count. | |
| solutions_list_assets | List assets inside a Nintex solution | Designer | Lists assets in a Nintex solution, including tables, workflows, forms, apps, document packages, and orchestrations. | |
| solutions_create | Create a Nintexsolution | Designer | Creates a Nintex solution for organizing related assets. Solutions created using MCP can only be deleted from the Nintex user interface. | |
| Users | users_find | Find users in the current tenant | Participant | Finds users in the current tenant by user ID or name and returns their account and role information. |
| users_get | Get a user by ID | Participant | Shows account details for a specific user, including their role and group memberships. | |
| users_get_groups | Get the groups a user belongs to | Participant | Lists the groups that a specific user belongs to in the current tenant. | |
| users_add | Create a user in the current tenant | Automation administrator | Creates a user in the current tenant with a specified email address, name, and role. | |
| users_update | Update a user in the current tenant | Automation administrator | Updates the role assigned to an existing user in the current tenant. | |
| users_delete | Delete a user from the current tenant | Automation administrator | Deletes a user from the current tenant. This action cannot be undone. | |
| Groups | groups_find | List groups in the current tenant | Participant | Lists groups available to the signed-in user in the current tenant. |
| groups_get | Get a group by ID (with members) | Participant | Shows details for a specific group, including its members and owners. | |
| groups_add | Create a group | Automation administrator | Creates a group in the current tenant. | |
| groups_update | Update a group | Automation administrator | Updates a group's name or description. | |
| groups_delete | Delete a group | Automation administrator | Deletes a group from the current tenant. This action cannot be undone. | |
| groups_add_users | Add users to a group | Automation administrator | Adds one or more users to an existing group. | |
| groups_remove_users | Remove users from a group | Automation administrator | Removes one or more users from a group without deleting their user accounts. | |
| Workflows | workflows_list | List workflow designs you own | Designer | Lists workflow designs you own in the current tenant. |
| workflows_get | Get workflow design detail | Designer | Returns the published design details for a workflow, including its start variables. | |
| workflows_track | Track workflows you're a business owner of | Participant | Shows workflow activity and instance statistics for workflows that the signed-in user owns as a business owner. | |
| Agentflows | agentflows_list | List agentflow designs you own | Designer | Lists agentflow designs you own in the current tenant. |
| agentflows_get | Get agentflow design detail | Designer | Returns the published design details for a agentflow. | |
| Instances | instances_start | Start an instance | Designer | Starts a workflow instance. This action cannot be undone. |
| instances_terminate | Terminate workflow instances | Designer | Terminates up to 20 running or paused workflow instances. Terminated instances cannot be resumed or restarted. | |
| instances_resubmit | Resubmit workflow instances | Designer | Resubmits up to 20 completed, failed, or terminated workflow instances using their original start data. Each resubmission starts a new workflow instance. | |
| instances_resolve | Resolve paused workflow instances | Designer | Resumes or fails up to 20 paused workflow instances. Resuming retries the failed step. Failing an instance ends it and cannot be undone. | |
| instances_list | List instances | Participant | Lists workflow or agentflow instances across workflows and agentflows in the tenant. | |
| instances_get | Get an instance | Participant | Shows details for a specific workflow or agentflow instance, including status and error information. | |
| instances_track_activity | Track a workflow instance's task activity | Participant | Shows the task / approval activity for a workflow instance | |
| instances_track | Track a workflow's instances (with stats) | Participant | Shows business owner monitoring of a workflow's instances with a stats breakdown. | |
| instances_get_start_data | Get an instances's start data | Participant | Get start data used to trigger an instance. | |
| Agents | agents_list_executions | List agent executions | Designer | Lists agent executions for the current tenant, with the most recent executions shown first. Includes the execution state, agent flow ID, session ID, and created, updated, and stopped timestamps. |
| agents_get_execution | Get agent execution | Designer | Shows details for a specific agent execution, including the prompt, messages, tool calls, tools used or available, token usage, and timing. | |
| Forms | forms_list | List submittable forms | Participant | Lists forms available for the current user to submit and saved drafts they can resume. |
| forms_list_submissions | List form submissions | Participant | Lists form submissions made by the current user within a date range. | |
| forms_delete_draft | Delete a draft form | Participant | Deletes a saved draft form. This action cannot be undone. | |
| Orchestrations | orchestrations_list | List Nintex Orchestrations | Designer | Lists orchestrations available to the signed-in user, including their status and draft or published version availability. |
| orchestrations_get | Get a Nintex Orchestration | Designer | Shows the published definition of a specific orchestration, including its start configuration, variables, phases, activities, and routing information. | |
| orchestrations_list_instances | List Nintex Orchestration instances | Designer | Lists orchestration instances in a specific solution, including their status, start time, and end time. | |
| orchestrations_get_instance | Get a Nintex Orchestration instance | Designer | Shows the progress of a specific orchestration instance, including its status, phases, steps, and errors. | |
| orchestrations_terminate_instance | Terminate a Nintex Orchestration instance | Designer | Terminates a running orchestration instance. This action cannot be undone. | |
| orchestrations_restore_instance | Resume a Nintex Orchestration instance | Designer | Resumes an orchestration instance from a specified phase and, optionally, a step. | |
| Governance | governance_list_tools | List Nintex MCP tool policy | Global administrator | Lists the Nintex MCP tools that can be managed in the tenant, including their availability, access requirements, and enabled status. |
| governance_set_tool_enabled | Enable or disable a Nintex MCP tool | Global administrator | Enables or disables a Nintex MCP tool for all users in the tenant. | |
| tenant_settings_get | Get Nintex AI settings | Automation administrator | Shows the tenant's Nintex AI settings, including MCP availability and permissions for managing MCP servers. | |
| Skills | skills_list | List available skills | Participant | Lists the skills available to the signed-in user in the current tenant, including their descriptions, versions, and tags. |
| skills_load | Load a skill | Participant | Loads a specific skill, including its instructions and information about tools that are unavailable to the signed-in user. |
Permission behavior
MCP tools follow the signed-in user's Nintex access. A tool may be available to a user, but the requested action can still fail if the user does not have permission to access the selected workflow, table, solution, user, group, or form. When a tool changes Nintex data, review the request before confirming the action.