Skip to main content

Litmus MCP Server

Project description

Litmus logo

Documentation Follow on LinkedIn

Litmus MCP Server

The official Litmus Automation Model Context Protocol (MCP) Server enables LLMs and intelligent systems to interact with 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.

Litmus MCP Server Architecture Diagram

Table of Contents


Quick Launch

Start an HTTP SSE MCP Server using Docker

Run the server in Docker (HTTP SSE only)

docker run -d --name litmus-mcp-server -p 8000:8000 ghcr.io/litmusautomation/litmus-mcp-server:latest

NOTE: The Litmus MCP Server is built for linux/AMD64 platforms. If running in Docker on ARM64, specify the AMD64 platform type by including the --platform argument:

docker run -d --name litmus-mcp-server --platform linux/amd64 -p 8000:8000 ghcr.io/litmusautomation/litmus-mcp-server:main

Claude Code CLI

Run Claude from a directory that includes a configuration file at ~/.claude/mcp.json:

{
  "mcpServers": {
    "litmus-mcp-server": {
      "type": "sse",
      "url": "http://localhost:8000/sse",
      "headers": {
        "EDGE_URL": "${EDGE_URL}",
        "EDGE_API_CLIENT_ID": "${EDGE_API_CLIENT_ID}",
        "EDGE_API_CLIENT_SECRET": "${EDGE_API_CLIENT_SECRET}",
        "NATS_SOURCE": "${NATS_SOURCE}",
        "NATS_PORT": "${NATS_PORT:-4222}",
        "NATS_USER": "${NATS_USER}",
        "NATS_PASSWORD": "${NATS_PASSWORD}",
        "INFLUX_HOST": "${INFLUX_HOST}",
        "INFLUX_PORT": "${INFLUX_PORT:-8086}",
        "INFLUX_DB_NAME": "${INFLUX_DB_NAME:-tsdata}",
        "INFLUX_USERNAME": "${INFLUX_USERNAME}",
        "INFLUX_PASSWORD": "${INFLUX_PASSWORD}"
      }
    }
  }
}

Anthropic Docs


Cursor IDE

Add to ~/.cursor/mcp.json or .cursor/mcp.json:

{
  "mcpServers": {
    "litmus-mcp-server": {
      "url": "http://<MCP_SERVER_IP>:8000/sse",
      "headers": {
        "EDGE_URL": "https://<LITMUSEDGE_IP>",
        "EDGE_API_CLIENT_ID": "<oauth2_client_id>",
        "EDGE_API_CLIENT_SECRET": "<oauth2_client_secret>",
        "NATS_SOURCE": "<LITMUSEDGE_IP>",
        "NATS_PORT": "4222",
        "NATS_USER": "<access_token_username>",
        "NATS_PASSWORD": "<access_token_from_litmusedge>",
        "INFLUX_HOST": "<LITMUSEDGE_IP>",
        "INFLUX_PORT": "8086",
        "INFLUX_DB_NAME": "tsdata",
        "INFLUX_USERNAME": "<datahub_username>",
        "INFLUX_PASSWORD": "<datahub_password>"
      }
    }
  }
}

Cursor docs


VS Code / GitHub Copilot

Manual Configuration

In VS Code: Open User Settings (JSON) → Add:

{
  "mcpServers": {
    "litmus-mcp-server": {
      "url": "http://<MCP_SERVER_IP>:8000/sse",
      "headers": {
        "EDGE_URL": "https://<LITMUSEDGE_IP>",
        "EDGE_API_CLIENT_ID": "<oauth2_client_id>",
        "EDGE_API_CLIENT_SECRET": "<oauth2_client_secret>",
        "NATS_SOURCE": "<LITMUSEDGE_IP>",
        "NATS_PORT": "4222",
        "NATS_USER": "<access_token_username>",
        "NATS_PASSWORD": "<access_token_from_litmusedge>",
        "INFLUX_HOST": "<LITMUSEDGE_IP>",
        "INFLUX_PORT": "8086",
        "INFLUX_DB_NAME": "tsdata",
        "INFLUX_USERNAME": "<datahub_username>",
        "INFLUX_PASSWORD": "<datahub_password>"
      }
    }
  }
}

Or use .vscode/mcp.json in your project.

VS Code MCP Docs


Windsurf

Add to ~/.codeium/windsurf/mcp_config.json:

{
  "mcpServers": {
    "litmus-mcp-server": {
      "url": "http://<MCP_SERVER_IP>:8000/sse",
      "headers": {
        "EDGE_URL": "https://<LITMUSEDGE_IP>",
        "EDGE_API_CLIENT_ID": "<oauth2_client_id>",
        "EDGE_API_CLIENT_SECRET": "<oauth2_client_secret>",
        "NATS_SOURCE": "<LITMUSEDGE_IP>",
        "NATS_PORT": "4222",
        "NATS_USER": "<access_token_username>",
        "NATS_PASSWORD": "<access_token_from_litmusedge>",
        "INFLUX_HOST": "<LITMUSEDGE_IP>",
        "INFLUX_PORT": "8086",
        "INFLUX_DB_NAME": "tsdata",
        "INFLUX_USERNAME": "<datahub_username>",
        "INFLUX_PASSWORD": "<datahub_password>"
      }
    }
  }
}

Windsurf MCP Docs

STDIO with Claude Desktop

This MCP server supports local connections with Claude Desktop and other applications via Standard file Input/Output (STDIO): https://modelcontextprotocol.io/legacy/concepts/transports

To use STDIO: Clone, edit config.py to enable STDIO, run the server as a local process, and update Claude Desktop MCP server configuration file to use the server:

Clone

# Clone 
git clone https://github.com/litmusautomation/litmus-mcp-server.git

Set ENABLE_STDIO to 'true' in /src/config.py:

ENABLE_STDIO = os.getenv("ENABLE_STDIO", "true").lower() in ("true", "1", "yes")

Run the server

# Run using uv 
uv sync
cd /path/to/litmus-mcp-server
uv run python3 src/server.py

# Otherwise
cd litmus-mcp-server
pip install -e .
python3 src/server.py

Add json server definision to your Claude Desktop config file:

  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  • Windows: %APPDATA%\Claude\claude_desktop_config.json
  • Linux: ~/.config/Claude/claude_desktop_config.json
{
  "mcpServers": {
    "litmus-mcp-server": {
      "command": "/path/to/.venv/bin/python3",
      "args": [
        "/absolute/path/to/litmus-mcp-server/src/server.py"
      ],
      "env": {
        "PYTHONPATH": "/absolute/path/to/litmus-mcp-server/src",
        "EDGE_URL": "https://<LITMUSEDGE_IP>",
        "EDGE_API_CLIENT_ID": "<oauth2_client_id>",
        "EDGE_API_CLIENT_SECRET": "<oauth2_client_secret>",
        "NATS_SOURCE": "<LITMUSEDGE_IP>",
        "NATS_PORT": "4222",
        "NATS_USER": "<access_token_username>",
        "NATS_PASSWORD": "<access_token_from_litmusedge>",
        "INFLUX_HOST": "<LITMUSEDGE_IP>",
        "INFLUX_PORT": "8086",
        "INFLUX_DB_NAME": "tsdata",
        "INFLUX_USERNAME": "<datahub_username>",
        "INFLUX_PASSWORD": "<datahub_password>"
      }
    }
  }
}

Tips

For development, use Python Virtual environments, for example to bridge mcp lib version diffs between dev clients like 'npx @modelcontextprotocol/inspector' & litmus-mcp-server

{
  "mcpServers": {
    "litmus-mcp-server": {
      "command": "/absolute/path/to/litmus-mcp-server/.venv/bin/python",
      "args": ["/absolute/path/to/litmus-mcp-server/src/server.py"],
      "env": { /* same as above */ }
    }
  }
}

See claude_desktop_config_venv.example.json for the complete template.

Header Configuration Guide:

  • EDGE_URL: Litmus Edge base URL (include https://)
  • EDGE_API_CLIENT_ID / EDGE_API_CLIENT_SECRET: OAuth2 credentials from Litmus Edge
  • NATS_SOURCE: Litmus Edge IP (no http/https)
  • NATS_USER / NATS_PASSWORD: Access token credentials from System → Access Control → Tokens
  • INFLUX_HOST: Litmus Edge IP (no http/https)
  • INFLUX_USERNAME / INFLUX_PASSWORD: DataHub user credentials

Available Tools

Category Function Name Description
DeviceHub get_litmusedge_driver_list List supported Litmus Edge drivers (e.g., ModbusTCP, OPCUA, BACnet).
get_devicehub_devices List all configured DeviceHub devices with connection settings and status.
create_devicehub_device Create a new device with specified driver and default configuration.
get_devicehub_device_tags Retrieve all tags (data points/registers) for a specific device.
get_current_value_of_devicehub_tag Read the current real-time value of a specific device tag.
Device Identity get_litmusedge_friendly_name Get the human-readable name assigned to the Litmus Edge device.
set_litmusedge_friendly_name Update the friendly name of the Litmus Edge device.
LEM Integration get_cloud_activation_status Check cloud registration and Litmus Edge Manager (LEM) connection status.
Docker Management get_all_containers_on_litmusedge List all Docker containers running on Litmus Edge Marketplace.
run_docker_container_on_litmusedge Deploy and run a new Docker container on Litmus Edge Marketplace.
NATS Topics * get_current_value_from_topic Subscribe to a NATS topic and return the next published message.
get_multiple_values_from_topic Collect multiple sequential values from a NATS topic for trend analysis.
InfluxDB ** get_historical_data_from_influxdb Query historical time-series data from InfluxDB by measurement and time range.
Digital Twins list_digital_twin_models List all Digital Twin models with ID, name, description, and version.
list_digital_twin_instances List all Digital Twin instances or filter by model ID.
create_digital_twin_instance Create a new Digital Twin instance from an existing model.
list_static_attributes List static attributes (fixed key-value pairs) for a model or instance.
list_dynamic_attributes List dynamic attributes (real-time data points) for a model or instance.
list_transformations List data transformation rules configured for a Digital Twin model.
get_digital_twin_hierarchy Get the hierarchy configuration for a Digital Twin model.
save_digital_twin_hierarchy Save a new hierarchy configuration to a Digital Twin model.

Tool Use Notes

* NATS Topic Tools Requirements: To use get_current_value_from_topic and get_multiple_values_from_topic, you must configure access control on Litmus Edge:

  1. Navigate to: Litmus Edge → System → Access Control → Tokens
  2. Create or configure an access token with appropriate permissions
  3. Provide the token in your MCP client configuration headers

** InfluxDB Tools Requirements: To use get_historical_data_from_influxdb, you must allow InfluxDB port access:

  1. Navigate to: Litmus Edge → System → Network → Firewall
  2. Add a firewall rule to allow port 8086 on TCP
  3. Ensure InfluxDB is accessible from the MCP server host

Litmus Central

Download or try Litmus Edge via Litmus Central.


MCP server registries

Litmus MCP server

© 2026 Litmus Automation, Inc. All rights reserved.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file iflow_mcp_litmusautomation_litmus_mcp_server-0.1.0.tar.gz.

File metadata

  • Download URL: iflow_mcp_litmusautomation_litmus_mcp_server-0.1.0.tar.gz
  • Upload date:
  • Size: 29.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.0 {"installer":{"name":"uv","version":"0.10.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for iflow_mcp_litmusautomation_litmus_mcp_server-0.1.0.tar.gz
Algorithm Hash digest
SHA256 fa3d919fb420fbf3c3b9927fbbd3214aecf85af9d3478d4836d893e617ec028b
MD5 2af524694ac9c655a362f08a0b392603
BLAKE2b-256 13878d320218531bb4480e3e4b6018fc1f6766a53738bfffbbc5b7a40e9fdc90

See more details on using hashes here.

File details

Details for the file iflow_mcp_litmusautomation_litmus_mcp_server-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: iflow_mcp_litmusautomation_litmus_mcp_server-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 29.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.0 {"installer":{"name":"uv","version":"0.10.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for iflow_mcp_litmusautomation_litmus_mcp_server-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a9ad38e7eaac38f6bae727c7aa63469d680196e62fd16df5d33259f337841158
MD5 18aea192c6f7b4486d8c0925b19eac30
BLAKE2b-256 8b8bb0e2f3654d3c540435ccd5eaf921951a2ff63aadf89e90418246f65a4d8e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page