Skip to main content

MCP server for controlling lights using overkiz

Project description

mcp-overkiz MCP server

MCP server for controlling lights using pyoverkiz

Components

Resources

The server implements a light control system with:

  • Custom light:// URI scheme for accessing individual light devices
  • Each light resource has a name and current state (On/Off)
  • The resources are automatically discovered from your Overkiz/Somfy account

Tools

The server implements three tools:

  • list-lights: Lists all available lights and their current status
    • Takes no arguments
  • light-on: Turns on a light by name
    • Takes "name" as a required string argument
  • light-off: Turns off a light by name
    • Takes "name" as a required string argument

Configuration

The server requires the following environment variables:

  • OVERKIZ_USERNAME: Your Overkiz/Somfy account username
  • OVERKIZ_PASSWORD: Your Overkiz/Somfy account password
  • OVERKIZ_SERVER: The Overkiz server to connect to (defaults to "somfy-europe")

Quickstart

Running with Claude Desktop

Claude Desktop

  • On MacOS: ~/Library/Application\ Support/Claude/claude_desktop_config.json
  • On Windows: %APPDATA%/Claude/claude_desktop_config.json
Published Servers Configuration
"mcpServers": {
  "overkiz-mcp": {
    "command": "uvx",
    "args": [
      "mcp-overkiz"
    ],
    "env": {
      "OVERKIZ_USERNAME": "your-email@example.com",
      "OVERKIZ_PASSWORD": "your-password",
      "OVERKIZ_SERVER": "somfy-europe"
    }
  }
}
Development/Unpublished Servers Configuration
"mcpServers": {
  "overkiz-mcp": {
    "command": "uv",
    "args": [
      "run",
      "/path/to/mcp-overkiz"
    ],
    "env": {
      "OVERKIZ_USERNAME": "your-email@example.com",
      "OVERKIZ_PASSWORD": "your-password",
      "OVERKIZ_SERVER": "somfy-europe"
    }
  }
}

Example Usage

Once the server is running and connected to Claude, you can control your lights with commands like:

  • "List all my lights"
  • "Turn on the living room light"
  • "Turn off the bedroom light"

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

mcp_overkiz-0.1.1.tar.gz (1.7 MB view details)

Uploaded Source

Built Distribution

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

mcp_overkiz-0.1.1-py3-none-any.whl (4.9 kB view details)

Uploaded Python 3

File details

Details for the file mcp_overkiz-0.1.1.tar.gz.

File metadata

  • Download URL: mcp_overkiz-0.1.1.tar.gz
  • Upload date:
  • Size: 1.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.2

File hashes

Hashes for mcp_overkiz-0.1.1.tar.gz
Algorithm Hash digest
SHA256 4a6abaa20c51156f733c112329a553088ca583c75aa9c73159fc5623ceb2f66f
MD5 17f0a529f815b306d1c0fd2954245fa8
BLAKE2b-256 340c0a0a8b09c8458d621d02d7d5b7a536c31a016a5eae12d385b23c4248b285

See more details on using hashes here.

File details

Details for the file mcp_overkiz-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for mcp_overkiz-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3e5654a7bd8ec1f0a7376f625b891d1af13c8a22f9b4f5f16e11f34eac327b49
MD5 ddb0a80210ab4b020db8a57b8d94e9a4
BLAKE2b-256 132c8531be8ede462e5b81a05f0ee32ce1271fb4e5dd886af95ae2da1eb610fc

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