Litmus MCP Server

What is Litmus MCP Server about?

Litmus MCP Server provides a Model Context Protocol (MCP) interface that lets large language models and intelligent systems interact with Litmus Edge devices. It exposes a set of API functions for environment configuration, device discovery, tag access, Docker container management, and cloud‑activation status, all streamed via Server‑Sent Events (SSE).

How to use Litmus MCP Server?

• Docker Quick Launch

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

• SSE Endpoint
  • Client connects to http://<server-ip>:8000/sse for real‑time streaming.
  • Requests are sent via regular HTTP POST.
• Integration Configuration (example for Cursor, Claude Desktop, VS Code, Windsurf)

  {
    "mcpServers": {
      "litmus-mcp-server": {
        "url": "http://<IP Address>:8000/sse"
      }
    }
  }
  

  Place the JSON in the appropriate location for the IDE or tool (e.g., ~/.cursor/mcp.json, claude_desktop_config.json, .vscode/mcp.json, ~/.codeium/windsurf/mcp_config.json).

Key Features

• Edge System Config – retrieve and update Litmus Edge connection settings.
• DeviceHub Management – list drivers, devices, tags, and fetch current tag values.
• Device Identity – get/set a friendly name for the Edge instance.
• LEM Integration – check cloud activation and Litmus Edge Manager status.
• Docker Management – list containers on Litmus Edge and launch new containers from the Marketplace.
• Topic Subscription – subscribe to live values on Litmus Edge topics, with optional batch retrieval for plotting.
• Server‑Sent Events transport – low‑latency, bi‑directional communication suitable for LLM‑driven workflows.

Use Cases

1. LLM‑driven device configuration – an AI assistant can call update_environment_config or update_config to re‑configure a Litmus Edge gateway on the fly.
2. Real‑time monitoring dashboards – SSE stream feeds live tag values to visualisation tools or chat interfaces.
3. Automated container deployment – orchestrate edge workloads using run_docker_container_on_litmusedge from within an AI workflow.
4. IDE integration – developers can invoke MCP functions directly from Cursor, VS Code Copilot, Claude Desktop, or Windsurf to prototype edge‑automation scripts.
5. Cloud‑edge status checks – get_cloud_activation_status helps maintain compliance and connectivity awareness.

FAQ

• How do I start the server? Use the Docker command shown above; the server listens on 0.0.0.0:8000/sse by default.
• What client libraries are needed? Any MCP‑compatible client can connect via the SSE endpoint; no additional libraries are required for basic HTTP POST requests.
• Can I run the server locally without Docker? The repository contains the source code; building it follows the language‑specific instructions in the repo (e.g., Go or Python build steps).
• How do I secure the endpoint? Deploy behind a reverse proxy with TLS termination and enforce authentication at the proxy layer.
• Which IDEs support this server out of the box? Cursor, Claude Desktop, VS Code (Copilot), and Windsurf all support MCP configuration via a simple JSON file as illustrated.

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.

Table of Contents

• Getting Started
  • Quick Launch (Docker)
  • Cursor IDE Setup
• API
• Usage
  • Server-Sent Events (SSE)
• Litmus Central
• Integrations
  • Cursor IDE
  • Claude Desktop
  • VS Code / Copilot
  • Windsurf

---

Getting Started

Quick Launch (Docker)

Run the server in Docker:

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

Cursor IDE Setup

Example mcp.json configuration:

{
  "mcpServers": {
    "litmus-mcp-server": {
      "url": "http://<IP Address>:8000/sse"
    }
  }
}

See the Cursor docs 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 for real-time communication.

• Client endpoint: http://<server-ip>: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.

---

Integrations

Cursor IDE

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

{
  "mcpServers": {
    "litmus-mcp-server": {
      "url": "http://<IP Address>:8000/sse"
    }
  }
}

Cursor docs

---

Claude Desktop

Add to claude_desktop_config.json:

{
  "mcpServers": {
    "litmus-mcp-server": {
      "url": "http://<IP Address>:8000/sse"
    }
  }
}

Anthropic Docs

---

VS Code / GitHub Copilot

Manual Configuration

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

{
  "mcpServers": {
    "litmus-mcp-server": {
      "url": "http://<IP Address>:8000/sse"
    }
  }
}

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://<IP Address>:8000/sse"
    }
  }
}

Windsurf MCP Docs

MCP server registries

• Glama

• MCP.so

---

© 2025 Litmus Automation, Inc. All rights reserved.