Version

    CloverDX MCP Server

    What is MCP?

    MCP (Model Context Protocol) is an emerging standard that enables AI agents to interact with external services and data sources. It provides a standardized way for AI models to access tools, resources, and context from various applications, allowing them to perform tasks beyond their base capabilities.

    CloverDX MCP Server exposes CloverDX functionality and resources to AI agents. The following resources and capabilities are available:

    • Server Info - Get current server status, version, and configuration details

    • CloverDX Info - Access CloverDX-specific system information

    • CloverDX Server Logs - Access general server logs for troubleshooting

    • Performance Logs - Monitor server performance metrics and bottlenecks

    • Access Logs - Review user access and authentication events

    • Job Run Logs - Examine detailed execution logs for specific jobs

    • Job Tracking Info - Query job execution history, status, and runtime details

    • CloverDX database SQL Select - Execute SELECT queries on CloverDX database

    • Report Support Issue - Report problem to CloverDx customer portal

    This allows AI agents to help with tasks such as:

    • Troubleshooting failed jobs by analyzing logs

    • Monitoring server health and performance

    • Automating routine administrative queries

    • Generating reports on job execution patterns

    Server Setup

    Version 7.3 and Newer

    MCP support is available out-of-the-box in CloverDX Server 7.3 and newer versions.
    CloverDX MCP server 7.3 and newer
    Configuration

    CloverDX Server 7.3+ includes MCP functionality by default. The following configuration properties control MCP behavior:

    # Enables the MCP functionality on this server needed for AI Support Assistant
clover.mcp.enabled=true

# Enables anonymous access for MCP. The 'clover' user has to be installed.
# Useful when using this server as a MCP proxy.
clover.mcp.anonymous.access.enabled=false

    These properties can be configured in your clover.properties file or through CloverDX Server configuration.

    Authentication Options

    You have two options for authenticating MCP connections:

    Option 1: OAuth2 Authentication (Default & Recommended)

    By default, MCP requires OAuth2 authentication between the client application and CloverDX Server.

    Prerequisites:

    • OAuth2 must be configured in CloverDX Server (Configuration → Setup → OAuth2 Authentication)

    • User accounts must have OAuth2 authentication enabled

    • User must exist and have appropriate permissions

    Configuration:

    1. Configure OAuth2 in CloverDX Server (OAuth2 Authentication)

    2. Client applications will require a valid OAuth2 Bearer token

    Option 2: Anonymous Access (Testing Only)

    For testing or development environments, you can enable anonymous access to bypass authentication.

    Anonymous access should only be used in secure, non-production environments. This allows any client to access your CloverDX Server without authentication.

    Configuration:

    1. Set the following property in clover.properties:

      clover.mcp.anonymous.access.enabled=true
    Version 6.0 - 7.2

    CloverDX Server versions 6.0-7.2 do not have native MCP support. To enable MCP functionality for these versions, you need to use a proxy architecture where a CloverDX Server 7.3+ acts as an MCP proxy that connects to your older server.
    Architecture Overview

    The setup requires two servers:

    • Proxy Server: CloverDX Server 7.3 or newer - handles MCP protocol and client connections

    • Legacy Server: CloverDX Server 6.0-7.2 - your actual server with jobs, data, and workflows

    Client applications connect to the proxy server, which then communicates with the target server via the CloverDX MCP Bridge.

    CloverDX MCP server 7.3 and newer
    Configuration
    Step 1: Configure the Proxy Server (7.3+)

    The proxy server needs standard MCP configuration plus remote connection settings.

    1.1 Enable MCP on the proxy server

    Edit clover.properties on your proxy server:

    # Enable MCP functionality
clover.mcp.enabled=true

# Enable anonymous access (recommended for proxy scenarios)
# The 'clover' user has to be installed
clover.mcp.anonymous.access.enabled=true

    1.2 Configure remote connection to target server

    Add these properties to connect to your 6.0-7.2 target server:

    # Determines whether this server should connect to a remote MCP instance
clover.mcp.remote.enabled=true

# URL of the remote MCP server (your 6.0-7.2 target server)
clover.mcp.remote.url=https://your-target-server.example.com/clover

# Username for authentication to the remote MCP server
clover.mcp.remote.user=mcp-bridge-user

# Password for authentication to the remote MCP server
clover.mcp.remote.password=your-secure-password

    Create a dedicated user account on the target server for the MCP bridge connection with appropriate permissions for accessing logs, jobs, and datasets. Use this user in the clover.mcp.remote.user property.

    1.3 Restart the proxy server

    Restart the CloverDX Server service to apply the configuration changes.

    Step 2: Configure the Target Server (6.0-7.2)

    The target server needs the CloverDX MCP Bridge Library installed and initialized.

    2.1 Install CloverDXMCPBridgeLib

    1. Log in to your target server (6.0-7.2)

    2. Navigate to Library → Marketplace (or https://marketplace.cloverdx.com/)

    3. Search for CloverDXMCPBridgeLib

    4. Click Install on the CloverDXMCPBridgeLib package

    5. Wait for the installation to complete

    2.2 Run the initialization job

    After installing the library, you need to run the initialization job to set up the MCP bridge:

    1. Navigate to Libraries > CloverDXMCPBridgeLib > Configuration in your target server

    2. Set library parameters (user used for the library initialization has to have Import server configuration permission)

    3. Click on "Initialize library"

    4. Verify the job completed successfully

    MCP Bridge initialization job
    Authentication Options for Client Connections

    Client applications connect to the proxy server (not the target server). You have two authentication options:

    Option 1: OAuth2 Authentication (Recommended for Production)

    Configure OAuth2 on the proxy server:

    Prerequisites:

    • OAuth2 must be configured in the proxy server (Configuration → Setup → OAuth2 Authentication)

    • User accounts must have OAuth2 authentication enabled

    Configuration:

    1. Set in proxy server’s clover.properties:

      clover.mcp.anonymous.access.enabled=false

    2. Configure OAuth2 in the proxy server:

      • Navigate to Configuration → Setup → OAuth2 Authentication

      • Enable and configure OAuth2 settings

      • Save the configuration

    3. Enable OAuth2 for users:

      • Go to Configuration → Users

      • Select each user account

      • Enable OAuth2 Authentication

      • Generate OAuth2 tokens for client applications

    Option 2: Anonymous Access (Testing/Development Only)

    For testing or development environments:

    Anonymous access should only be used in secure, non-production environments. This allows any client to access your servers without authentication.

    Configuration:

    1. Set in proxy server’s clover.properties:

      clover.mcp.anonymous.access.enabled=true

    2. Restart the proxy server

    Client Setup

    This section describes how to connect AI desktop applications to your CloverDX Server using MCP. Currently supported clients include Claude Desktop and ChatGPT Desktop applications.

    Authentication Requirements:

    • If OAuth2 is not configured in CloverDX Server (Configuration → Setup → OAuth2 Authentication), you must set clover.mcp.anonymous.access.enabled=true on the server

    • If OAuth2 is configured, clients must provide a valid Bearer token when connecting
    Claude Desktop Application
    Prerequisites

    • Claude desktop app installed - https://www.claude.com/download

    • CloverDX MCP Extension file (CloverDX-MCP.mcpb) which can you downloaded from Customer Portal page

    Installation and Configuration

    1. Open the Claude desktop app

    2. Navigate to Settings → Extensions

    3. Install the CloverDX MCP Extension:

      If you already have extensions installed:

      • Simply drag the CloverDX-MCP.mcpb file into the Extensions area

      If this is your first extension:

      1. Click Advanced Settings

      2. Scroll down to Extension Developer

      3. Click the Install Extension button

      4. Locate the CloverDX-MCP.mcpb file and click Install

    4. Fill in the following configuration fields:

    5. Click Save

    6. Toggle the extension switch to Enabled

    Claude desktop extension configuration
    Usage

    1. Start a new chat in the Claude desktop app

    2. You can choose which MCP prompt to use from the available options, or leave it unselected

      If unselected, Claude will automatically choose the appropriate MCP tools based on your prompt.
    MCP prompt selector in Claude

    1. Example prompts to try:

      • "There are some example prompts under the plus icon and Add from CloverDX MCP section."

    MCP prompt selector in Claude
    Using CloverDX MCP in Claude chat
    ChatGPT Desktop Application

    Currently is not possible to use OAuth2 to connect to CloverDX MCP (use the anonymous access instead as a workaround). There is an open issue related to the "Error fetching OAuth configuration"
    Prerequisites

    • ChatGPT Subscription:

      • A premium ChatGPT plan is required (Plus, Pro, Business, or Enterprise)

      • Connectors are not supported in the Free/Go subscription

    • Authentication Requirements:

      • If OAuth2 is not configured (Configuration → Setup → OAuth2 Authentication):

        • You must set clover.mcp.anonymous.access.enabled=true on the server to enable MCP without OAuth2

      • If OAuth2 is configured (Configuration → Setup → OAuth2 Authentication):

        • The clover user must have OAuth2 Authentication enabled

    • Network Requirements:

      • CloverDX Server must use the HTTPS protocol - HTTP-only is not supported by OpenAI/ChatGPT

        For local test environments, you can use a tunneling application such as ngrok (https://ngrok.com/) to expose your local HTTP server via HTTPS.

      • Firewall rules must allow inbound and outbound traffic to/from OpenAI server IP addresses

        • There is no official documentation providing ChatGPT server IP ranges

        • The ChatGPT client sends requests from different source IP addresses - identifying and allowing a single IP address is not sufficient

        • Some user forums discuss unofficial IP address lists used by ChatGPT

        • These IP addresses may change at any time and are outside our control
    Installation and Configuration

    1. Click on your profile name in the ChatGPT desktop app

    2. Select Settings → Connectors

    3. Scroll down to Advanced settings and expand it

    4. Enable Developer mode

    5. Click the Back button to return to the Connectors view

    6. At the top, click the Create button

    7. Fill in the connector configuration:

    8. Click Create