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.
The Commvault MCP Server enables seamless integration with Commvault environments, offering the following:
Category | Features |
---|---|
Job Management | • View job details and history • Control jobs (suspend, resume, resubmit, kill) • Monitor job status and performance |
Commcell Management | • Retrieve SLA status and compliance • View security posture and scores • Access storage space utilization metrics • Get commcell details and entity counts |
Client Management | • Access client groups and client information • Manage subclients and client properties • View client associations |
Storage Management | • View storage policies and configurations • Access storage pool information • Monitor storage resources |
User Management | • List users and user groups • Access security associations • Manage user permissions |
Plan Management | • View plan configurations and details • Access plan components and settings |
Schedule Management | • Access backup schedules • View schedule configurations • Monitor schedule performance |
Before running the Commvault MCP Server, ensure the following requirements are met:
- Python 3.11 or higher
uv
package manager (used for dependency management and running the server)
The Commvault MCP Server supports two authentication methods:
Option 1: OAuth Authentication
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.
Option 2: Traditional Token-Based Authentication
The following values will be collected during the setup process:
-
Commvault Access Credentials: You need a valid
access_token
andrefresh_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.
git clone https://github.com/Commvault/commvault-mcp-server.git
cd commvault-mcp-server
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
uv run -m src.server
Note:
npx
is required while using Token-Based Authentication. You can get it by installing Node.js which includesnpx
by default.
While using OAuth
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.
Remote MCP Server (Streamable HTTP / SSE)
{
"mcpServers": {
"Commvault": {
"command": "npx",
"args": ["mcp-remote", "HOST:PORT/mcp", "--header", "Authorization: <secret stored in server keyring>"]
}
}
}
Remote MCP Server (Client on Windows)
{
"mcpServers": {
"Commvault": {
"command": "cmd",
"args": ["/c", "npx", "mcp-remote", "HOST:PORT/mcp", "--header", "Authorization: <secret stored in server keyring>"]
}
}
}
Remote MCP Server (HTTP)
{
"mcpServers": {
"Commvault": {
"command": "npx",
"args": ["mcp-remote", "HOST:PORT/mcp", "--header", "Authorization: <secret stored in server keyring>", "--allow-http"]
}
}
}
Local MCP Server (STDIO)
{
"mcpServers": {
"Commvault": {
"command": "C:\\YOUR\\PATH\\TO\\commvault-mcp-server\\.venv\\bin\\python",
"args": [
"C:\\YOUR\\PATH\\TO\\commvault-mcp-server\\src\\server.py"
]
}
}
}
- 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.
This project is licensed under the Apache License. See the LICENSE file for details.