Lifx Api MCP Server

🚀 LIFX MCP Server

An MCP (Multi-functional Plugin) server that controls LIFX lights through natural language processing. Use English or Chinese commands like "turn on the kitchen lights" or "让厨房灯亮起来".

✨ Features

• Supports English and Chinese commands.
• Built - in multiple tools: listing lights, setting states, toggling power, etc.
• Provides various prompting functions: selector helper, effect creation, troubleshooting, etc.
• Configurable settings, including API keys and language preferences.
• Docker support for easy deployment.

📦 Installation

1. Clone the repository:

   git clone https://github.com/furey/lifx-api-mcp-server.git
   cd lifx-api-mcp-server
   

2. Install dependencies:

   npm install -g lifx-api-mcp-server
   

3. Start the server:

   lifx-api-mcp-server
   

📚 Documentation

Configuration

Create a configuration file config.json with the following content:

{
  "lifxApiKey": "your_api_key_here",
  "language": "zh" // or "en"
}

Replace the API key with your actual key and choose the language (Chinese or English).

Project Overview

This server allows you to control LIFX lights via natural language commands. It supports multiple functions, including listing lights, changing states, toggling power, etc.

Tool List

• list-lights: List all lights.
• set-state: Set the state of a light (on/off).
• toggle-power: Toggle the power state of a light.
• state-delta: Adjust the attributes of a light (brightness, color, etc.).

Usage Examples

Basic Usage

1. List available lights:

   @lix-api:lifx://lights
   

2. Get the state of a specific light:

   @lix-api:lifx://light/label:Your Light Name/state
   

Advanced Usage

3. Use the selector helper:

   @lix-api:selector-helper Target: Lights in the kitchen
   

4. Create an effect:

   @lix-api:effect-creator Effect Type: Breathe Selector: All Light Description: Slowly change to warm white
   

5. Troubleshoot:

   @lix-api:troubleshooter Selector: "id:d073d5xxxxxx"
   

Docker Support

Build an image using the following Dockerfile:

FROM node:18-alpine

WORKDIR /app

# Copy package files
COPY package*.json ./

# Install dependencies (production mode)
RUN npm ci --omit=dev --production --no-fund --no-audit

# Copy application code
COPY . .

# Set the entry point
ENTRYPOINT ["node", "lifx-api-mcp-server.js"]

# Default command (can be overridden if needed)
# CMD ["YOUR_DEFAULT_TOKEN_IF_NEEDED"]

⚠️ Important Note

• This software is provided "as is" without any express or implied warranty.
• Make sure to install Node.js and npm before use.
• If you encounter any problems, please refer to the documentation or contact the developer.

📄 Support

For help or to report issues, please visit the GitHub repository.