› Integration › MCP servers › Configure TotalAgility MCP server

Configure TotalAgility MCP server

The TotalAgility MCP server provides a suite of tools that can be utilized within TotalAgility via a chat control or an MCP activity.

When you install TotalAgility, the TotalAgility MCP server is available out-of-the-box within the MCP integrations. It includes tools to create a new job or case, take an activity, get a work queue, and more.

To configure the server, you can edit the MCP Server settings to:

  • Set the URL to point to the relevant web server.
  • Add or remove tools from the tool list.

To add a tool, the you must select one of the following as the source:

  • An agent
  • A synchronous process
  • A custom service
Before you begin

You must update the URL for the TotalAgility MCP Server service and add tools before using the MCP server.

The TotalAgility MCP server is not available for third-party applications. The TotalAgility MCP Server does not support an "Allow All" option, which is available on external MCP Servers. Instead, synchronous processes must be added as tools one at a time. This approach prevents processes from being unintentionally exposed and ensures each one is made available as a deliberate action.

  1. Navigate to Integration > MCP servers.

    The MCP servers page appears. By default, the TotalAgility MCP server is available.

  2. Select to configure the MCP server connection.

    The Edit MCP server dialog box is displayed.

  3. The ID and Display name for the MCP server connection are displayed as (read-only).
  4. On the Category list, select the category with which you want to associate the MCP server. By default, your working category is selected.
  5. In the URL box, enter the URL of the TotalAgility MCP server.
    If the "Allow all" system setting is not enabled, you can only provide the host name that is whitelisted; otherwise, a message appears stating the connection is denied because the URL connection string is not whitelisted. See Whitelist a web service URL or a database connection string.
  6. Add the Custom tools.
    1. Select .

      The Add tool dialog box is displayed.

    2. On the Process list, you can select a synchronous process, agent, or custom service.
    3. The Tool name field automatically displays the process name without spaces. However, you can modify the tool name as required.

      You can edit the tool name after saving it. You cannot use the same process to create different custom tools. Each custom tool should have a unique synchronous process, agent, or custom service.

    4. Select Add.

      The custom tool is added to the table displaying the tool name, tool type, process name, and description. The description is taken from the variable when a process is exposed as a tool on the TotalAgility MCP Server.

      You can edit or remove the custom tool.

    5. Add more custom tools as required and select Save.

      The configuration is saved, and listed on the MCP servers page.

      You cannot delete the TotalAgility MCP server but can view the associations.

      When you configure a chat or activity that supports MCP server, you can select the TotalAgility MCP Server and further refine the tools available to tailor them for a specific use case. When you interact with the chat or execute the activity, using the TotalAgility MCP Server,

      • The configured TotalAgility MCP Server tools from the selected MCP Server are executed where appropriate based on the process and description. The MCP server is treated like any other with regards to getting consent to execute tools.
      • If a tool execution requires a synchronous process, a synchronous job is created automatically. Initialization and output variable descriptions from the selected process are passed to the LLM.
      • Each tool execution is recorded in the audit log.

    If the logged-on user doesn't have sufficient permission on the tool (process) an error is returned.

Manage custom tools

For the TotalAgility MCP server, you can add, edit, and remove custom tools that expose synchronous processes, agents, or custom services as tools for LLM invocation. Custom tools allow you to expose your TotalAgility processes as tools that can be invoked by Large Language Models (LLMs) based on their name and description. The selected process must support documents. Each tool is associated with a synchronous process, agent, or custom service.

Edit a custom tool

Procedure
  1. On the MCP servers page, select the TotalAgility MCP server to open for modification.

    The Edit MCP server dialog box is displayed with the Custom Tools list.

  2. Under Custom tools, locate the tool you want to edit and select .

    The Edit tool dialog box is displayed.

  3. Modify the Tool name as required.

    Tool names cannot contain spaces. The tool name is used by the LLM to identify and invoke the tool.

  4. Select Save.

    The tool name is updated in the Custom tools list. The change is recorded in the audit log with details including the old tool name, new tool name, and the resource who made the change.

  5. Select Save on the Edit MCP server dialog box to save all changes.

Remove a Custom Tool

When you remove a Custom Tool, it is no longer available for selection in chat controls or MCP activities. If the tool was previously configured in a form or activity, an error occurs if the tool is invoked.

If an MCP tool is removed or renamed, opening the MCP server integration refreshes the tool list and notifies you of the changes. You must reselect the tools before continuing.

Procedure
  1. On the MCP servers page, select the TotalAgility MCP server to open for modification.

    The Edit MCP server dialog box is displayed with the Custom Tools list.

  2. Under Custom tools, locate the tool you want to remove and select .

    A confirmation message is displayed.

  3. Confirm the deletion.

    The tool is removed from the Custom tools list. The removal is recorded in the audit log with details including the tool name, process name, and the resource who removed it.

  4. Select Save on the Edit MCP server dialog box to save all changes.
More info