https://github.com/litmusautomation/litmus-mcp-server
Official MCP server for configuring Litmus instances.
https://github.com/litmusautomation/litmus-mcp-server
industrial mcp mcp-server
Last synced: 3 months ago
JSON representation
Official MCP server for configuring Litmus instances.
- Host: GitHub
- URL: https://github.com/litmusautomation/litmus-mcp-server
- Owner: litmusautomation
- License: apache-2.0
- Created: 2025-05-01T21:45:01.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-05-17T18:15:22.000Z (5 months ago)
- Last Synced: 2025-05-17T19:23:37.678Z (5 months ago)
- Topics: industrial, mcp, mcp-server
- Language: Python
- Homepage: https://litmus.io/
- Size: 324 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-mcp-servers - **litmus-mcp-server** - Official MCP server for configuring Litmus instances. `python` `industrial` `mcp` `mcp-server` `server` `pip install git+https://github.com/litmusautomation/litmus-mcp-server` (AI/ML)
- awesome-mcp-servers - **litmus-mcp-server** - Official MCP server for configuring Litmus instances. `python` `industrial` `mcp` `mcp-server` `server` `pip install git+https://github.com/litmusautomation/litmus-mcp-server` (AI/ML)
- Awesome-Official-MCP-Servers - Litmus.io - mcp-server?style=social) | Official MCP server for configuring [Litmus](https://litmus.io) Edge for Industrial Data Collection, Edge Analytics & Industrial AI. | | (官方 MCP 服务器列表)
- Awesome-Official-MCP-Servers - Litmus.io - mcp-server?style=social) | Official MCP server for configuring [Litmus](https://litmus.io) Edge for Industrial Data Collection, Edge Analytics & Industrial AI. | | (官方 MCP 服务器列表)
README
# Litmus MCP Server
The official [Litmus Automation](https://litmus.io) **Model Context Protocol (MCP) Server** enables LLMs and intelligent systems to interact with [Litmus Edge](https://litmus.io/products/litmus-edge) for device configuration, monitoring, and management. It is built on top of the MCP SDK and adheres to the [Model Context Protocol spec](https://modelcontextprotocol.io/).
## Table of Contents
- [Getting Started](#getting-started)
- [Quick Launch (Docker)](#quick-launch-docker)
- [Cursor IDE Setup](#cursor-ide-setup)
- [API](#api)
- [Usage](#usage)
- [Server-Sent Events (SSE)](#server-sent-events-sse)
- [Litmus Central](#litmus-central)
- [Integrations](#integrations)
- [Cursor IDE](#cursor-ide)
- [Claude Desktop](#claude-desktop)
- [VS Code / Copilot](#vs-code--copilot)
- [Windsurf](#windsurf)
---
## Getting Started
### Quick Launch (Docker)
Run the server in Docker:
```bash
docker run -d --name litmus-mcp-server -p 8000:8000 ghcr.io/litmusautomation/litmus-mcp-server:main
```
### Cursor IDE Setup
Example `mcp.json` configuration:
```json
{
"mcpServers": {
"litmus-mcp-server": {
"url": "http://:8000/sse"
}
}
}
```
See the [Cursor docs](https://docs.cursor.com/context/model-context-protocol) for more info.
---
## API
| Category | Function Name | Description |
|---------------------------|----------------------------------------|-------------|
| **Edge System Config** | `get_current_environment_config` | Get current environment configuration used for Litmus Edge connectivity. |
| | `update_environment_config` | Update environment variable config for connecting to Litmus Edge. |
| | `get_current_config` | Retrieve current Litmus Edge instance configuration. |
| | `update_config` | Update configuration of the device or container running Litmus Edge. |
| **DeviceHub** | `get_litmusedge_driver_list` | List supported Litmus Edge drivers. |
| | `get_devicehub_devices` | List devices configured in DeviceHub. |
| | `get_devicehub_device_tags` | Retrieve tags for a specific DeviceHub device. |
| | `get_current_value_of_devicehub_tag` | Get current value of a specific device tag. |
| | `create_devicehub_device` | Register a new DeviceHub device. Supports various protocols and templates for register-based data polling. |
| **Device Identity** | `get_litmusedge_friendly_name` | Retrieve the user-friendly name of the device. |
| | `set_litmusedge_friendly_name` | Assign or update the friendly name. |
| **LEM Integration** | `get_cloud_activation_status` | Check cloud activation and Litmus Edge Manager (LEM) connection status. |
| **Docker Management** | `get_all_containers_on_litmusedge` | List all containers on Litmus Edge. |
| | `run_docker_container_on_litmusedge` | Launch a Docker container via Litmus Edge Marketplace (not the MCP host). |
| **Topic Subscription** | `get_current_value_on_topic` | Subscribe to current values on a Litmus Edge topic. Use global `NATS_STATUS = False` to unsubscribe. |
| | `get_multiple_values_from_topic` | Retrieve multiple values from a topic for plotting or batch access. |
---
## Usage
### Server-Sent Events (SSE)
This server supports the [MCP SSE transport](https://modelcontextprotocol.io/docs/concepts/transports#server-sent-events-sse) for real-time communication.
- **Client endpoint:** `http://:8000/sse`
- **Default binding:** `0.0.0.0:8000/sse`
- **Communication:**
- Server → Client: Streamed via SSE
- Client → Server: HTTP POST
---
## Litmus Central
Download or try Litmus Edge via [Litmus Central](https://central.litmus.io).
---
## Integrations
### Cursor IDE
Add to `~/.cursor/mcp.json` or `.cursor/mcp.json`:
```json
{
"mcpServers": {
"litmus-mcp-server": {
"url": "http://:8000/sse"
}
}
}
```
[Cursor docs](https://docs.cursor.com/context/model-context-protocol)
---
### Claude Desktop
Add to `claude_desktop_config.json`:
```json
{
"mcpServers": {
"litmus-mcp-server": {
"url": "http://:8000/sse"
}
}
}
```
[Anthropic Docs](https://docs.anthropic.com/en/docs/agents-and-tools/mcp)
---
### VS Code / GitHub Copilot
#### Manual Configuration
In VS Code:
Open User Settings (JSON) → Add:
```json
{
"mcpServers": {
"litmus-mcp-server": {
"url": "http://:8000/sse"
}
}
}
```
Or use `.vscode/mcp.json` in your project.
[VS Code MCP Docs](https://code.visualstudio.com/docs/copilot/chat/mcp-servers)
---
### Windsurf
Add to `~/.codeium/windsurf/mcp_config.json`:
```json
{
"mcpServers": {
"litmus-mcp-server": {
"url": "http://:8000/sse"
}
}
}
```
[Windsurf MCP Docs](https://docs.windsurf.com/windsurf/mcp)
### MCP server registries
- [Glama](https://glama.ai/mcp/servers/@litmusautomation/litmus-mcp-server)
- [MCP.so](https://mcp.so/server/litmus-mcp-server/litmusautomation)
---
© 2025 Litmus Automation, Inc. All rights reserved.