> For the complete documentation index, see [llms.txt](https://docs.xorosoft.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.xorosoft.com/other-products/mcp-usage/what-is-mcp-usage-module.md).

# What is MCP Usage module

### Overview

The **XoroERP MCP (Model Context Protocol) Module** enables AI clients, such as ChatGPT, to securely connect with XoroERP and access approved ERP capabilities through a scoped connection.

Once connected, ChatGPT can dynamically invoke the tools exposed by the XoroERP MCP integration to answer business queries, retrieve operational metrics, and access authorized ERP data.

Specific ERP capabilities, such as checking inventory, retrieving employee details, and reviewing order status, are mapped to descriptive tools that AI clients can invoke using natural language.

The MCP connection operates within the access permissions assigned to the linked ERP user and the associated Private App.

{% hint style="warning" %}
The MCP functionality is **subscription-based** and is not enabled by default. Access to the MCP App Module can be enabled by Xorosoft Support following a discussion and approval from the Sales team.

Once the subscription is approved and the module is enabled, users can configure a Private App, establish a secure MCP connection, and access approved ERP capabilities through a compatible AI client.
{% endhint %}

<figure><img src="https://3188343778-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fkf8DNCjEfcSm64PCPcmf%2Fuploads%2F6xGzSlVHyKPfxXNzDSax%2Fimage.png?alt=media&amp;token=db67a564-3b32-4196-8a13-9f0e22bfd363" alt=""><figcaption></figcaption></figure>

#### Accessing the MCP Module

The MCP functionality can be accessed through either of the following modules:

* **MCP Usage Module:** **Menu>Admin> MCP Usage** - Provides visibility into MCP usage, subscription details, active connections, and usage trends.
* **Private App Module:** Allows users to create and configure a Private App with MCP connectivity.

### MCP Usage Module

The MCP Usage Module provides visibility into MCP subscription utilization, connection activity, and usage trends for an ERP instance.

It allows authorized users and support personnel to review how MCP is being used, monitor available question allowances, and manage subscription-related settings.

The module provides information such as:

* Who used the MCP connection.
* Current question allowance and usage.
* Available question balance.
* Next cycle information.
* Active connections.
* Manual resets.
* Instance-level usage.
* Usage during the current cycle, last 30 days, or last 90 days.
* MCP usage trends.

### MCP Usage Metrics

| Field              | Description                                                                        |
| ------------------ | ---------------------------------------------------------------------------------- |
| User               | Displays the ERP user associated with MCP activity.                                |
| Used               | Displays the number of questions consumed during the applicable usage period.      |
| Available Now      | Displays the remaining question allowance available for use.                       |
| Cycle Allowance    | Displays the total question allowance assigned for the current subscription cycle. |
| Next Cycle         | Displays information about the next usage cycle.                                   |
| Active Connections | Displays the number of active MCP connections.                                     |
| Manual Resets      | Displays the number of manual usage resets performed.                              |
| Instance Usage     | Displays MCP usage at the ERP instance level.                                      |
| Usage Period       | Allows users to review usage for the current cycle, last 30 days, or last 90 days. |
| Usage Trend        | Displays the MCP usage trend over the selected period.                             |

***

#### Update Subscription

The **Update Subscription** option allows authorized users to modify the MCP subscription associated with the ERP instance.

Changes made here affect the live MCP subscription. Use this option only after confirming the customer's contract or obtaining the required support approval.

Click **Update Subscription** to open the subscription configuration pop-up.

<figure><img src="https://3188343778-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fkf8DNCjEfcSm64PCPcmf%2Fuploads%2FOkqL1fOnv7ltD2v3FSrk%2Fimage.png?alt=media&amp;token=ab6550e0-9acf-4259-8db6-764f633eca0f" alt=""><figcaption></figcaption></figure>

#### Subscription Fields

| Field                       | Description                                                                                                                                                                                  |
| --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Subscription Plan           | Defines the MCP question allowance assigned to the ERP instance. Available plans include Trial (100 questions), Plus (200 questions), Pro (400 questions), and Enterprise (2,000 questions). |
| Status                      | Defines the current subscription status. Available options are Active, Suspended, and Deregistered.                                                                                          |
| Question Allowance Override | Allows an authorized user to override the default question allowance for the subscription.                                                                                                   |
| Request Reset               | Allows the user to request a reset of the MCP question allowance.                                                                                                                            |
| Save                        | Saves the subscription changes.                                                                                                                                                              |

#### Subscription Status Options

| Status       | Description                                                |
| ------------ | ---------------------------------------------------------- |
| Active       | Indicates that the MCP subscription is active.             |
| Suspended    | Indicates that the MCP subscription has been suspended.    |
| Deregistered | Indicates that the MCP subscription has been deregistered. |

### MCP Subscription

The **XoroERP MCP Module** is subscription-based. A trial plan is available to help users get started with MCP functionality.

#### Initial Trial Plan

**When MCP is initially enabled for an ERP instance, the subscription starts with the Trial plan, with a defined number of questions available for initial MCP usage.**

Once the trial allowance is exhausted or if additional MCP usage is required, you can upgrade to a higher subscription plan by clicking **Upgrade Subscription** and contacting the **Xorosoft Support Team**.

#### Upgrading the Subscription

If you need to move from the Trial plan to a higher subscription plan:

1. Open the **MCP Usage** module.
2. Click **Upgrade Subscription**.
3. Contact the **Xorosoft Support Team** to discuss the available subscription options and complete the upgrade process.

The appropriate subscription can be selected based on the organization's MCP usage requirements.

{% hint style="info" %}
**Subscription changes are applied to the ERP instance and should be made after confirming the applicable subscription with the Xorosoft Support Team.**
{% endhint %}

***

The XAdmin Support View provides support personnel with visibility into MCP usage, Private App activity, connections, and recent usage events.

**Support personnel can inspect usage details and submit subscription or reset changes.**

{% hint style="info" %}
**Note:** If MCP Approval Mode is enabled, subscription or reset changes are submitted as approval requests in the MCP Portal before they are applied.
{% endhint %}

The XAdmin Support View contains the following tabs:

1. Overview
2. Private Apps
3. Connections
4. Support Audit

#### Common Filters

The same set of filters is available across all four tabs. These filters allow support personnel to narrow down the information displayed based on the selected criteria.

<figure><img src="https://3188343778-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fkf8DNCjEfcSm64PCPcmf%2Fuploads%2F8yFkFxKtLIZHSwpWkN8J%2Fimage.png?alt=media&amp;token=d94d533b-45dc-4b1d-935c-1420bf511339" alt=""><figcaption></figcaption></figure>

| Filter      | Description                                                                                                                 |
| ----------- | --------------------------------------------------------------------------------------------------------------------------- |
| Private App | Allows users to select All Private Apps or a specific Private App to view its associated MCP information.                   |
| ERP User    | Filters MCP information based on the associated ERP user.                                                                   |
| Connection  | Filters information based on the connection status, such as Active, Disconnected, or Inactive.                              |
| Event Type  | Filters information based on the event type, such as Completion, Reservation, Stale, Pending, or Completion-related events. |

***

#### Overview Tab

The Overview tab provides a consolidated view of MCP usage and activity for the selected ERP instance or Private App.

Support personnel can apply the common filters to review MCP activity based on the selected Private App, ERP user, connection status, and event type.

This tab helps provide a high-level view of MCP usage and connection activity.

***

#### Private Apps Tab

The Private Apps tab provides usage details for individual Private Apps configured within the ERP instance.

Support personnel can use the common filters to narrow down the information displayed for specific Private Apps or ERP users.

**Column Descriptions**

| Column      | Description                                                                           |
| ----------- | ------------------------------------------------------------------------------------- |
| Private App | Displays the name of the Private App associated with the usage record.                |
| Hash        | Displays the hash identifier associated with the Private App usage record.            |
| Used        | Displays the number of questions used by the Private App.                             |
| Pending     | Displays the number of pending questions or requests associated with the Private App. |
| Blocked     | Displays the number of blocked questions or requests associated with the Private App. |
| Last Used   | Displays the date and time when the Private App was last used.                        |

***

#### Connections Tab

The Connections tab provides information about MCP connections established through the configured Private Apps.

Support personnel can use the common filters to review connection details and identify the associated client, authentication information, ERP user, and connection status.

**Column Descriptions**

| Column       | Description                                                                                      |
| ------------ | ------------------------------------------------------------------------------------------------ |
| Private App  | Displays the name of the Private App associated with the connection.                             |
| Agent/Client | Displays the agent or client associated with the MCP connection.                                 |
| Auth         | Displays the authentication information or authentication method associated with the connection. |
| ERP User     | Displays the ERP user linked to the MCP connection.                                              |
| Status       | Displays the current connection status.                                                          |
| Last Seen    | Displays the date and time when the connection was last seen.                                    |

***

#### Support Audit Tab

The Support Audit tab provides a record of recent MCP usage events and support-related activities.

Support personnel can use this tab to review event details, identify the associated Private App and user, and inspect usage or reset-related information.

The common filters are available to narrow down the audit records.

**Column Descriptions**

| Column        | Description                                                             |
| ------------- | ----------------------------------------------------------------------- |
| Time          | Displays the date and time when the event occurred.                     |
| Private App   | Displays the name of the Private App associated with the event.         |
| Event         | Displays the type of MCP event recorded.                                |
| Manual Resets | Displays the manual reset information associated with the audit record. |
| Cycle Resets  | Displays the cycle reset information associated with the audit record.  |
| Reason        | Displays the reason associated with the event or support action.        |
| Tool          | Displays the MCP tool associated with the event, where applicable.      |
| Questions     | Displays the question usage associated with the event.                  |
| User          | Displays the user associated with the event.                            |

***

### XoroERP MCP Setup and Configuration

Follow the steps below to enable MCP access in XoroERP, configure a Private App, and connect it to ChatGPT.

#### Step 1: Before configuring the MCP connection, ensure that **MCP has been enabled for your ERP instance**.

&#x20;If MCP is not available, contact the **Xorosoft Support Team** for assistance.

Once access is enabled, proceed to configure the Private App.

#### Step 2: Create and Configure a Private App

1. Navigate to the **Private App Module** in XoroERP.
2. Create a new **Private App**.
3. Enter the required details and configure the MCP settings as described below.

| Field                                      | Description                                                                                                                         |
| ------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------- |
| App Name                                   | Enter a name to identify the Private App.                                                                                           |
| Description                                | Enter a brief description of the Private App and its intended purpose.                                                              |
| Enable MCP connection for this Private App | Select this checkbox to enable MCP connectivity. This option is required for MCP clients and connectors and is disabled by default. |
| Linked ERP User                            | Select the ERP user to associate with the Private App. This field is required when MCP connectivity is enabled.                     |

After configuring the Private App and assigning the required access, click **Save**.

#### Step 3: Copy the Private App Credentials

After saving the Private App, the **Private App Created** pop-up window appears.

This window displays the credentials required for the MCP connection.

| Credential | Description                                 |
| ---------- | ------------------------------------------- |
| API Key    | The API key generated for the Private App.  |
| Password   | The password generated for the Private App. |

**Important:** Copy and securely store both credentials when the pop-up appears. For security reasons, these credentials will not be displayed again.

If the credentials need to be retrieved or rotated later, submit a support ticket.

Once the credentials have been saved securely, proceed to configure the MCP connection in ChatGPT.

#### Step 4: Enable Developer Mode in ChatGPT

1. Open ChatGPT.
2. Navigate to **Plugins**.
3. Open the **Security and Login** tab.
4. Enable **Developer Mode**.
5. Return to the Plugins tab.

Developer Mode allows you to add a custom MCP connection.

#### Step 5: Add a New MCP Connection

1. In the Plugins tab, click the **+ (Add)** button to add a new account.
2. The **New Plugin** window appears.
3. Enter the following connection details:

| Field                   | Description                                                                                                                          |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| Name                    | Enter a name to identify the connection, such as `XoroERP MCP`.                                                                      |
| Description             | Enter a brief description of the connection, such as `Connect ChatGPT to XoroERP through MCP to access authorized ERP capabilities.` |
| Connection – Server URL | Enter the XoroERP MCP server URL: `https://mcp-erp.xorosoft.io`                                                                      |
| Authentication          | Select `OAuth` as the authentication method.                                                                                         |

4. Verify the entered details.
5. Proceed to create or add the connection.

#### Step 6: Connect to XoroERP MCP

After adding the new plugin, proceed with the connection process.

The **Connect XoroERP MCP** screen appears.

> Connect your XORO Private App to work with approved ERP capabilities through a secure, scoped MCP connection.

Use the credentials generated during Private App creation to establish the connection, as prompted.

Ensure that you use the credentials associated with the Private App configured for MCP connectivity.

#### Step 7: Authorize the MCP Connection

After providing the required connection details, proceed to authorization.

The **Authorize XoroERP MCP** screen appears.

> Confirm the connection details before continuing.

Review the connection information and complete the authorization process.

Once the connection is successfully authorized, the connected account will appear in the plugin details.

#### Step 8: Verify Analytics Access and Start Using MCP

After establishing the connection, verify that the linked ERP user has access to the required Analytics Studio models.

1. Navigate to **Analytical Studio > Administration > Access Manager** in XoroERP.
2. Select the relevant dashboard from the sidebar.
3. Review the access grants for the required models, such as AP Bill Headers, Chart of Accounts, and other applicable models.
4. Ensure that the linked ERP user has the required permissions.

Once the connection and permissions are configured, you can begin asking ChatGPT natural-language questions about authorized ERP data and operational metrics.

For example, you can ask questions related to inventory, order status, or financial information, depending on the MCP tools and analytics models available to your connected account.

{% hint style="info" %}
**Note:** The data and capabilities available through MCP are determined by the permissions assigned to the linked ERP user and the tools exposed through the MCP connection.
{% endhint %}

### Summary

The XoroERP MCP Module enables secure, permission-based access to ERP capabilities through AI clients such as ChatGPT.

The Private App Module is used to configure MCP connectivity and assign the required ERP user and analytics permissions. Once connected, ChatGPT can access approved tools and analytics models based on the permissions assigned to the linked ERP user.

The MCP Usage Module and XAdmin Support View provide visibility into usage, subscriptions, connections, and audit events, allowing authorized users and support personnel to monitor and manage MCP activity.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.xorosoft.com/other-products/mcp-usage/what-is-mcp-usage-module.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.