Cumulocity MCP Server
by Cumulocity-IoT
The Cumulocity MCP Server is a Python-based server that provides Cumulocity IoT platform functionality through the MCP (Model Control Protocol) interface. It enables seamless interaction with Cumulocity's device management, measurements, and alarm systems.
Last updated: N/A
Cumulocity MCP Server
A Python-based server that provides Cumulocity IoT platform functionality through the MCP (Model Control Protocol) interface. This server enables seamless interaction with Cumulocity's device management, measurements, and alarm systems.
Available Tools
Device Management
-
Get Devices
- List and filter devices
- Parameters:
type
: Filter by device typename
: Filter by device namepage_size
: Results per page (max 2000)current_page
: Page number
-
Get Device by ID
- Retrieve detailed information for a specific device
- Parameter:
device_id
: Device identifier
-
Get Child Devices
- View child devices of a specific device
- Parameter:
device_id
: Parent device identifier
-
Get Device Fragments
- Access device fragments and their values
- Parameter:
device_id
: Device identifier
Measurements
Get Device Measurements
- Retrieve device measurements with time filtering
- Parameters:
device_id
: Device identifierdate_from
: Start date (ISO 8601 format)date_to
: End date (ISO 8601 format)page_size
: Number of measurements to retrieve
Alarms
Get Active Alarms
- Monitor active alarms in the system
- Parameters:
severity
: Filter by severity levelpage_size
: Number of results to retrieve
Installation
Using uv (recommended)
When using uv
no specific installation is needed. We will
use uvx
to directly run mcp-server-c8y.
Using PIP
Alternatively you can install mcp-server-c8y
via pip:
pip install mcp-server-c8y
After installation, you can run it as a script using:
python -m mcp_server_c8y
Usage with Claude Desktop
This MCP Server can be used with Claude Desktop to enable Claude to interact with your Cumulocity IoT platform. Follow these steps to set it up:
-
Download and install Claude Desktop
-
Configure Claude Desktop to use this MCP Server:
- Open Claude Desktop
- Click on the Claude menu and select "Settings..."
- Navigate to "Developer" in the left-hand bar
- Click "Edit Config"
-
Add the following configuration to your
claude_desktop_config.json
:
"mcpServers": {
"c8y": {
"command": "uvx",
"args": ["mcp-server-c8y"],
"env": {
"C8Y_BASE_URL": "https://your-cumulocity-instance.com",
"C8Y_TENANT_ID": "your-tenant-id",
"C8Y_USERNAME": "your-username",
"C8Y_PASSWORD": "your-password"
}
}
}
</details>
<details>
<summary>Using pip installation</summary>
"mcpServers": {
"c8y": {
"command": "python",
"args": ["-m", "mcp_server_c8y"],
"env": {
"C8Y_BASE_URL": "https://your-cumulocity-instance.com",
"C8Y_TENANT_ID": "your-tenant-id",
"C8Y_USERNAME": "your-username",
"C8Y_PASSWORD": "your-password"
}
}
}
</details>
Replace the following placeholders with your actual values:
https://your-cumulocity-instance.com
: Your Cumulocity instance URLyour-tenant-id
: Your Cumulocity tenant IDyour-username
: Your Cumulocity usernameyour-password
: Your Cumulocity password
-
Restart Claude Desktop
-
You should now see a hammer icon in the bottom right corner of the input box. Click it to see the available Cumulocity tools.
For more detailed information about using MCP Servers with Claude Desktop, visit the official MCP documentation.
Options
--session, -s
: Specify a Cumulocity session-v, --verbose
: Increase verbosity (can be used multiple times)
Contributing
We welcome contributions from everyone! Here's how you can contribute to this project:
- Fork the repository
- Create a new branch for your feature or bugfix
- Make your changes following these best practices:
- Write clear, descriptive commit messages
- Follow the existing code style and conventions
- Add tests for new features
- Update documentation as needed
- Ensure all tests pass
- Submit a pull request