Ledfx MCP

🚀 LedFX MCP Server

A Model Context Protocol (MCP) server enabling AI assistants to interact with and control a local LedFX instance.

🚀 Quick Start

This MCP server serves as a bridge between AI assistants (such as Claude) and LedFX, allowing you to control your LED lighting setup using natural language.

✨ Features

• 🎨 Control LED effects through natural language.
• 🔧 Manage multiple LED devices and virtuals.
• 🎭 Activate pre - configured scenes.
• 📊 Query device and system information.
• 🔒 Type - safe TypeScript implementation.
• 🏗️ Built following software design best practices.
• 🎨 LedFX colors & gradients via /api/colors (builtin + user - defined).
• 🗂️ Palette management stored as user gradients in LedFX.
• 🤖 AI - powered scene creation from natural language descriptions.
• 📝 Playlist support for scene sequences.
• 💡 Effect recommendations based on mood and description.
• 📚 LedFX feature explanations - learn about any LedFX concept.
• 🔄 Correct API implementation - uses virtuals (not devices) for effects.

🔧 Technical Details

Design Principles

This project adheres to principles from:

Grokking Simplicity

• Separation of Concerns: Actions (I/O operations) are clearly separated from calculations (pure functions).
• Stratified Design: Clear abstraction layers (tools → client → API).
• Immutability: Data transformations use pure functions where possible.

A Philosophy of Software Design

• Deep Modules: Complex LedFX API interactions are hidden behind simple interfaces.
• Information Hiding: Implementation details are abstracted from callers.
• Minimize Complexity: Each module has a single, focused responsibility.

Implementation Status

Current Status: Implemented with Comprehensive Test Suite

This MCP server is implemented against current LedFX APIs and validated with automated tests plus continuous integration checks. The implementation fixes critical API issues (virtuals vs devices) and adds advanced features like palette management, natural language scene creation, and AI - powered recommendations.

Important Notes

1. API Corrections Applied: Effects are correctly applied to virtuals (not devices), matching current LedFX API behavior.
2. Comprehensive Testing: 34 tests covering unit and E2E scenarios - all passing.
3. CI/CD Pipeline: GitHub Actions workflow with lint, build, test, and coverage jobs.
4. Production Ready: Fully documented with installation guide, usage examples, and architecture docs.

Documentation

• API Specification - Complete LedFX API reference.
• Test Specification - Comprehensive test plans.
• Implementation Notes - Design decisions and technical notes.
• References - LedFX resources and links.
• Installation Guide - Step - by - step setup instructions.
• Usage Guide - How to use all features.

Status: Ready for production use with LedFX 2.1.4+

📦 Installation

Prerequisites

• Node.js 24 or 25.
• A running LedFX instance (default: localhost:8888).
• An MCP - compatible AI assistant (e.g., Claude Desktop).

Running LedFX for Testing

Using Docker (Recommended):

# Using docker-compose (included in this repository)
docker-compose up -d

# Or using docker run
docker run -d --name ledfx -p 8888:8888 ledfxorg/ledfx:latest

Using pip:

pip install ledfx
ledfx --host 0.0.0.0 --port 8888

See the official LedFX links in REFERENCES.md for current installation docs.

Installing the Server

# Clone the repository
git clone https://github.com/abossard/ledfx-mcp.git
cd ledfx-mcp

# Install dependencies
npm install

# Build and run in one command
npm run dev

📚 Documentation

API Specification

docs/API_SPECIFICATION.md

Complete reference for LedFX REST API endpoints (verified against LedFX 2.1.4 and upstream source):

• All endpoint paths, methods, and parameters.
• Data model and orchestration caveats (virtuals, presets, scenes, playlists, blender).
• API behavior quirks and compatibility notes.

Test Specification

docs/TEST_SPECIFICATION.md

Comprehensive test requirements and test cases:

• Unit test cases for all components.
• Integration test scenarios.
• End - to - end workflows.
• Performance test criteria.
• Compatibility test matrix.
• Mock strategies and test fixtures.
• Docker - based test environment setup.

Implementation Notes

docs/IMPLEMENTATION_NOTES.md

Critical analysis of current implementation vs actual API:

• Known issues and bugs (devices vs virtuals confusion).
• Required fixes before production use.
• Missing features and functionality gaps.
• Recommended implementation phases.
• Migration path for future versions.

References

docs/REFERENCES.md

Concise source index for API verification:

• Official LedFX documentation links.
• Release/version links.
• Upstream source files used to validate API behavior.

💻 Usage Examples

Claude Desktop Configuration

Add the following to your Claude Desktop configuration file:

• Claude Desktop launches this MCP server over stdio.
• Use Node.js 24 or 25.
• The path must be absolute when using node with dist/index.js.

MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json Windows: %APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "ledfx": {
      "command": "node",
      "args": ["/absolute/path/to/ledfx-mcp/dist/index.js"],
      "env": {
        "LEDFX_HOST": "localhost",
        "LEDFX_PORT": "8888"
      }
    }
  }
}

If you prefer to run from Git without a local build, use npx as the command:

{
  "mcpServers": {
    "ledfx": {
      "command": "npx",
      "args": ["github:abossard/ledfx-mcp"],
      "env": {
        "LEDFX_HOST": "localhost",
        "LEDFX_PORT": "8888"
      }
    }
  }
}

Example Interactions

Once configured, you can interact with your LedFX setup through natural language:

Basic Operations:

• "List all my LED virtuals"
• "Activate the rainbow effect on my desk light virtual"
• "Show me all available scenes"
• "Clear effects from all virtuals"

Natural Language Scene Creation:

• "Create a calm ocean scene with slow blue waves"
• "Make an energetic party scene with fast rainbow colors"
• "Create a romantic scene with dim pink and purple gradients"
• "Build a focus scene with steady white light at medium brightness"

Color and Palette Management:

• "List all LedFX colors and gradients"
• "Get color or gradient 'sunset'"
• "Create a user color 'my - magenta' = #FF00FF"
• "Create a new palette called 'Sunset Vibes' with #FFA500, #FF69B4, #800080"
• "Save a playlist of my party scenes"

Effect Recommendations:

• "Recommend effects for a relaxing evening"
• "What effects work well with music?"
• "Suggest something energetic for a party"

Learning LedFX:

• "Explain what virtuals are in LedFX"
• "What's the difference between devices and virtuals?"
• "How do audio - reactive effects work?"
• "Tell me about WLED devices"
• "List all available effect types"

📄 License

MIT License - see LICENSE file for details

📚 Available Tools

The server exposes 40+ MCP tools organized into categories:

Core Management

Effect Control (CORRECTED - uses virtuals)

Scene Management

Palette Management (LedFX /api/colors)

Playlist Management

Color Management (LedFX /api/colors)

AI Features

Preset Management

Audio Management

🛠️ Development

# Install dependencies
npm install

# Build the project
npm run build

# Build and run in one command
npm run dev

# Watch mode for development
npm run watch

# Build and run in one command
npm run dev

# Lint the code
npm run lint

# Fix linting issues
npm run lint:fix

📁 Project Structure

ledfx-mcp/
├── src/
│   ├── index.ts         # Main server entry point
│   ├── ledfx-client.ts  # LedFX API client
│   └── tools.ts         # MCP tool definitions and handlers
├── docs/                # Comprehensive documentation
│   ├── API_SPECIFICATION.md      # LedFX API reference
│   ├── TEST_SPECIFICATION.md     # Test plans and requirements
│   ├── IMPLEMENTATION_NOTES.md   # Known issues and fixes needed
│   └── REFERENCES.md             # LedFX resources and links
├── dist/                # Compiled JavaScript (generated)
├── docker-compose.yml   # Docker setup for testing
├── package.json         # Project configuration
├── tsconfig.json        # TypeScript configuration
└── README.md           # This file

🏗️ Architecture

The server is organized into three main layers:

1. MCP Server Layer (index.ts): Handles MCP protocol communication.
2. Tools Layer (tools.ts): Defines available tools and routes requests.
3. Client Layer (ledfx-client.ts): Abstracts LedFX HTTP API interactions.

This layered architecture ensures:

• Clear separation of concerns.
• Easy testing and maintenance.
• Extensibility for new features.

🤝 Contributing

Contributions are welcome! Please ensure your code:

• Follows the existing code style.
• Includes appropriate comments.
• Passes linting (npm run lint).
• Builds successfully (npm run build).

📖 Resources

• LedFX Documentation
• Model Context Protocol
• MCP TypeScript SDK

🚑 Troubleshooting

Server won't connect to LedFX

• Ensure LedFX is running and accessible at the configured host/port.
• Check firewall settings.
• Verify the LEDFX_HOST and LEDFX_PORT environment variables.

Tools not appearing in Claude

• Restart Claude Desktop after configuration changes.
• Verify the path to dist/index.js is absolute.
• Check Claude Desktop logs for errors.

🆘 Support

For issues and questions:

• GitHub Issues
• LedFX Community