Commvault MCP Server

A Model Context Protocol (MCP) server for seamless integration with Commvault environments. This server enables AI agents to securely access and manage job details, commcell metrics, client and storage information, user permissions, plan configurations, and backup schedules.

Features

The Commvault MCP Server enables seamless integration with Commvault environments, offering the following:

Category	Features
Job Management	• View job details and history<br>• Control jobs (suspend, resume, resubmit, kill)<br>• Monitor job status and performance
Commcell Management	• Retrieve SLA status and compliance<br>• View security posture and scores<br>• Access storage space utilization metrics<br>• Get commcell details and entity counts
Client Management	• Access client groups and client information<br>• Manage subclients and client properties<br>• View client associations
Storage Management	• View storage policies and configurations<br>• Access storage pool information<br>• Monitor storage resources
User Management	• List users and user groups<br>• Access security associations
Plan Management	• View plan configurations and details<br>• Access plan components and settings
Schedule Management	• Access backup schedules<br>• View schedule configurations<br>• Monitor schedule performance
DocuSign Integration	• Setup Docusign Vault & Workflow<br>• Backup envelopes to Commvault S3 vault<br>• List & restore DocuSign envelope backups

Prerequisites

Before running the Commvault MCP Server, ensure the following requirements are met:

1. Python Environment

• Python 3.11 or higher
• uv package manager (used for dependency management and running the server)

2. Authentication & Security Configuration

The Commvault MCP Server supports two authentication methods:

<details> <summary>Option 1: OAuth Authentication</summary> <br/>

Note: OAuth authentication is only supported for Commvault environments running SP42 CU 27 and above. OAuth must be properly configured in the CommServe before using this option.

When using OAuth authentication, you'll need:

• Discovery Endpoint URL: The OAuth discovery/metadata endpoint
• Client ID: Your OAuth application's client identifier
• Client Secret: Your OAuth application's client secret
• Required Scopes: Required OAuth scopes
• Base URL: Base URL of the MCP Server

Important: The redirect URI must be set to OAUTH_BASE_URL/auth/callback in your OAuth provider's app/client configuration. </details>

<details> <summary>Option 2: Traditional Token-Based Authentication</summary> <br/>

The following values will be collected during the setup process:

• Commvault Access Credentials: You need a valid access_token and refresh_token to authenticate with the Commvault API. Learn how to generate these tokens here: Creating an Access Token – Commvault Docs

• Secret Key: This secret must be included by the MCP Client in the Authorization header of all tool requests. It acts as a security layer for tool access in remote server. You can set your own. </details>

Setup

1. Clone the repository

git clone https://github.com/Commvault/commvault-mcp-server.git
cd commvault-mcp-server

2. Run the Setup Script

The setup script will guide you through configuration options including:

• Transport mode (stdio, streamable-http, or sse)
• Server connection details (for remote modes)
• Authentication method (traditional tokens or OAuth)
• OAuth configuration (if selected)
• Secure token storage

uv run setup.py

3. Start the MCP Server

uv run -m src.server

<details> <summary>Secure Production Deployment</summary> <br/>

For production deployments, it is recommended to use a reverse proxy with TLS/HTTPS and security headers. The MCP server should bind to 127.0.0.1 (localhost only) to prevent direct public access.

Quick Setup

1. Configure MCP Server for localhost: Set MCP_HOST=127.0.0.1 in your .env file
2. Install reverse proxy: Choose nginx or Caddy
3. Configure TLS: Use Let's Encrypt for automatic certificate management
4. Add security headers: Configure OWASP-recommended headers (HSTS, X-Frame-Options, CSP, etc.)
5. Update client config: Use https://your-domain.com/mcp instead of http://HOST:PORT/mcp

</details>

Configuring Clients

Note: npx is required while using Token-Based Authentication. You can get it by installing Node.js which includes npx by default.

<details> <summary>While using OAuth</summary> <br/>

Refer to your AI client’s documentation for integration steps. For example, Claude requires specifying a server name and the MCP server URL in its connector configuration.

</details>

<details> <summary>Remote MCP Server (Streamable HTTP / SSE)</summary>

{
  "mcpServers": {
    "Commvault": {
      "command": "npx",
      "args": ["mcp-remote", "HOST:PORT/mcp", "--header", "Authorization: <secret stored in server keyring>"]
    }
  }
}

</details>

<details> <summary>Remote MCP Server (Client on Windows)</summary>

{
  "mcpServers": {
    "Commvault": {
      "command": "cmd",
      "args": ["/c", "npx", "mcp-remote", "HOST:PORT/mcp", "--header", "Authorization: <secret stored in server keyring>"]
    }
  }
}

</details>

<details> <summary>Remote MCP Server (HTTP)</summary>

{
  "mcpServers": {
    "Commvault": {
      "command": "npx",
      "args": ["mcp-remote", "HOST:PORT/mcp", "--header", "Authorization: <secret stored in server keyring>", "--allow-http"]
    }
  }
}

</details>

<details> <summary>Local MCP Server (STDIO) - Unix</summary>

{
  "mcpServers": {
    "Commvault": {
      "command": "C:\\YOUR\\PATH\\TO\\commvault-mcp-server\\.venv\\bin\\python",
      "args": [
        "C:\\YOUR\\PATH\\TO\\commvault-mcp-server\\src\\server.py"
      ]
    }
  }
}

</details>

<details> <summary>Local MCP Server (STDIO) - Windows</summary>

{
  "mcpServers": {
    "Commvault": {
      "command": "C:\\YOUR\\PATH\\TO\\commvault-mcp-server\\.venv\\Scripts\\python.exe",
      "args": [
        "C:\\YOUR\\PATH\\TO\\commvault-mcp-server\\src\\server.py"
      ]
    }
  }
}

</details>

Additional Configuration

Note: These are optional integrations that extend the MCP server's capabilities.

<details> <summary>DocuSign Backup Integration</summary> <br/>

The DocuSign backup integration enables backup of completed DocuSign envelopes to a Commvault S3 vault. This integration provides comprehensive document management capabilities including backup, listing, and restore operations.

Prerequisites

1. Environment Variable: Set ENABLE_DOCUSIGN_TOOLS=true in your environment
2. Commvault S3 Vault: Configure an S3 endpoint in Commvault
   • Learn more: Getting Started with S3 Vault
3. DocuSign API Access: Valid DocuSign integration credentials

Configuration Files

Create the following files in the config/ directory:

1. DocuSign Configuration (docusign_config.json)

Based on the template file config/docusign_config_template.json:

{
  "docusign": {
    "integrationKey": "YOUR_INTEGRATION_KEY_HERE",
    "userId": "YOUR_USER_ID_HERE", 
    "authServer": "account-d.docusign.com",
    "scopes": "signature impersonation",
    "basePath": "https://demo.docusign.net/restapi"
  },
  "fromDate": "2024-07-01T00:00:00Z"
}

2. DocuSign Private Key (docusign_key.pem)

Place your DocuSign private key file in the config/ directory as docusign_key.pem.

</details>

Contributing

• We're continuing to add more functionality to this MCP server. If you'd like to leave feedback, file a bug or provide a feature request, please open an issue on this repository.
• Pull requests are welcome! For major changes, please open an issue first to discuss what you would like to change.

License

This project is licensed under the Apache License. See the LICENSE file for details.