Litmus MCP Server

Litmus MCP Server

What is Litmus MCP Server about?

The server acts as a bridge between language models or other intelligent agents and Litmus Edge installations, exposing configuration, device discovery, Docker management, and telemetry operations through a standardized MCP API.

How to use Litmus MCP Server?

1. Quick start with Docker:

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

2. Connect a client via Server‑Sent Events at http://<server‑ip>:8000/sse.
3. Add the server to your IDE (Cursor, Claude Desktop, VS Code, Windsurf) by inserting a JSON block like:

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

4. Invoke the listed API functions (e.g., get_current_config, run_docker_container_on_litmusedge) using HTTP POST payloads defined by the MCP spec.

Key features of Litmus MCP Server

• Edge system configuration – retrieve and update Litmus Edge connectivity settings.
• DeviceHub management – list devices, tags, and current tag values; create new devices with protocol templates.
• Device identity handling – get/set user‑friendly device names.
• LEM cloud activation status – check Litmus Edge Manager connectivity.
• Docker container orchestration – enumerate and launch containers on Litmus Edge through the marketplace.
• Topic subscription – stream real‑time values from Litmus Edge topics via SSE.
• Broad IDE integrations – pre‑configured snippets for Cursor, Claude Desktop, VS Code / Copilot, and Windsurf.

Use cases of Litmus MCP Server

• Automated device provisioning – let an LLM script the enrollment of new sensors or actuators.
• Real‑time monitoring dashboards – stream telemetry to downstream analytics or chat‑based assistants.
• Edge‑to‑cloud CI/CD – trigger Docker container deployments on Edge devices directly from code‑generation tools.
• Smart troubleshooting – query configuration and status automatically when anomalies are detected.

FAQ

Q: Do I need to build the server from source? A: No, the Docker image (ghcr.io/litmusautomation/litmus-mcp-server:main) provides a ready‑to‑run instance.

Q: Which transport does the server use? A: Server‑Sent Events (SSE) for server‑to‑client streaming; client requests are standard HTTP POST.

Q: How do I secure the endpoint? A: Run the container behind a reverse proxy (e.g., Nginx) with TLS and authentication, or restrict network access to trusted hosts.

Q: Can I extend the API? A: The server follows the MCP SDK; custom functions can be added by extending the underlying SDK and rebuilding the image.

Q: Which IDEs are supported? A: Cursor, Claude Desktop, VS Code / Copilot, and Windsurf all provide MCP configuration snippets for this server.

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.