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",
      "--directory",
      "/path/to/project/folder/mcp-overkiz",
      "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.2.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.2-py3-none-any.whl (5.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mcp_overkiz-0.1.2.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.2.tar.gz
Algorithm Hash digest
SHA256 17d4f0fd205e3560cc89eae000e5c85466c910dd2950bfbc53097c68ebc038d3
MD5 872438b3f71ba96048c219c36af8761b
BLAKE2b-256 27cc0eb11a0ab2b54fc27402928eb9c429d15c5406ae237846ea093eb9a17018

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mcp_overkiz-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 1c855cef3f00e6c4fb9d6efc93c0e1fd5206363f59632d6c858b51dd1c25bc09
MD5 dc998727abf52b8a1a87734ebe80c0bc
BLAKE2b-256 ceaa56babe514372f31711706824347422a4c268479aa36d542510b2b3230581

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