MCP-HA-Connect

A production-ready Model Context Protocol (MCP) server for Home Assistant integration with AI assistants like Claude.

MCP-HA-Connect

A production-ready Model Context Protocol (MCP) server for Home Assistant integration with AI assistants like Claude and LM Studio.

npm version Docker

See docs/QUICK_START.md for Docker, HTTP server mode, n8n integration, and more installation options.

Key Features

Core Functionality

  • Smart Device Control
  • Lights: Brightness, color temperature, RGB color, transitions
  • Climate: Temperature, HVAC modes, fan modes, humidity
  • Covers: Position and tilt control
  • Switches: On/off control
  • Sensors & Contacts: State monitoring
  • Media Players: Playback control, volume, source selection
  • Fans: Speed, oscillation, direction
  • Locks: Lock/unlock control
  • Vacuums: Start, stop, return to base
  • Cameras: Motion detection, snapshots

Automation Management

  • List all automations with status
  • Trigger automations manually with variables
  • Enable/disable/toggle automations
  • Create new automations via API
  • Delete automations
  • View automation execution traces
  • Reload automations from configuration

System Features

  • Direct Home Assistant API integration
  • Long-lived access token authentication
  • Entity state management
  • Service call support
  • Advanced entity search
  • AI-powered sensor analysis with Ollama
  • Multiple transport modes (stdio, Streamable HTTP)
  • HTTP server with health checks
  • CORS support for browser-based clients
  • Structured logging (plain, JSON, GCP-JSON formats)
  • Comprehensive configuration validation with Zod
  • Full type safety with TypeScript
  • Stateful and stateless session support
  • JWT authentication with role-based access control

Available Tools (60 Total)

Home Assistant Tools (35)

State & Entity Tools

ToolDescription
getStatesGet all entity states from Home Assistant
getStateGet the state of a specific entity by entity_id
getEntitiesByDomainGet all entities for a specific domain
searchEntitiesSearch for entities by name or entity_id
getAllSensorsGet all sensor and binary_sensor entities
listEntitiesList entities with filtering (domain, state, search, limit)
getDomainSummaryGet summary statistics for a domain
getHistoryGet historical data for an entity
listPersonsList all household members with location state (home/away)

Service & Control Tools

ToolDescription
callServiceCall any Home Assistant service
entityActionSimple turn_on/turn_off/toggle actions

Device Control Tools

ToolDescription
controlLightControl lights with brightness, color, temperature
controlClimateControl thermostats with temperature, HVAC mode
controlMediaPlayerControl media players with playback, volume
controlCoverControl covers/blinds with position, tilt
controlFanControl fans with speed, oscillation, direction
activateSceneActivate a Home Assistant scene
runScriptRun a Home Assistant script
sendNotificationSend notifications with full mobile app support (actions, priority, images)
listNotificationTargetsDiscover available mobile app notification targets

Automation Tools

ToolDescription
listAutomationsList all automations with status
triggerAutomationManually trigger an automation
enableAutomationEnable a disabled automation
disableAutomationDisable an automation
toggleAutomationToggle automation state
reloadAutomationsReload automations from config
createAutomationCreate a new automation
deleteAutomationDelete an automation
getAutomationTraceGet automation execution history

System Tools

ToolDescription
getVersionGet Home Assistant version and config info
restartHomeAssistantRestart the Home Assistant server
getSystemLogGet system log entries from logbook
checkUpdatesCheck for available updates

Calendar Tools

ToolDescription
listCalendarsList all calendar entities
getCalendarEventsGet events from one or all calendars

Omada Network Tools (24)

Site Tools

ToolDescription
omada_listSitesList all sites configured on the Omada controller

Device Tools

ToolDescription
omada_listDevicesList all network devices (APs, switches, gateways) in a site
omada_getDeviceGet detailed information about a specific network device
omada_searchDevicesSearch for devices globally across all sites
omada_getSwitchStackDetailGet detailed information about a switch stack
omada_listDevicesStatsGet statistics for global adopted devices with filtering

Client Tools

ToolDescription
omada_listClientsList all connected clients (devices/users) in a site
omada_getClientGet detailed information about a specific connected client
omada_listMostActiveClientsGet the most active clients sorted by total traffic
omada_listClientsActivityGet client activity statistics over time
omada_listClientsPastConnectionsGet historical client connection data

Rate Limit Tools

ToolDescription
omada_getRateLimitProfilesGet available rate limit profiles for a site
omada_setClientRateLimitSet custom bandwidth limits for a client (download/upload in Kbps)
omada_setClientRateLimitProfileApply a rate limit profile to a client
omada_disableClientRateLimitRemove bandwidth limits from a client

Security Tools

ToolDescription
omada_getThreatListGet security threat management list

Network Configuration Tools

ToolDescription
omada_getInternetInfoGet internet connection configuration for a site
omada_getPortForwardingStatusGet port forwarding rules (User or UPnP)
omada_getLanNetworkListGet LAN network configuration list
omada_getLanProfileListGet LAN profile configuration list
omada_getWlanGroupListGet WLAN group configuration list
omada_getSsidListGet SSID list for a WLAN group
omada_getSsidDetailGet detailed SSID configuration
omada_getFirewallSettingGet firewall configuration for a site

AI Tools (1)

ToolDescription
analyzeSensorsAnalyze sensor data using AI (Ollama) to detect issues and provide recommendations

MCP Resources

Resource URIDescription
hass://entitiesList all entities grouped by domain
hass://entities/{entity_id}Get state of a specific entity
hass://entities/{entity_id}/detailedGet detailed entity info with all attributes
hass://entities/domain/{domain}Get all entities for a domain
hass://search/{query}/{limit}Search entities with result limit

Prerequisites

  • Node.js 20+ (tested with v20.19.6) - for npm/npx methods
  • npm 10.8+ (tested with v10.8.2) - for npm/npx methods
  • Docker (optional) - for Docker method
  • Home Assistant instance with long-lived access token
  • Network access to your Home Assistant instance
  • (Optional) Ollama for AI-powered analysis

Getting Your Home Assistant Token

  1. Log into your Home Assistant instance
  2. Click on your profile (bottom left)
  3. Scroll down to "Long-Lived Access Tokens"
  4. Click "Create Token"
  5. Give it a name (e.g., "MCP Server")
  6. Copy the token (shown only once!)

Environment Variables

Required

VariableDescriptionExample
HA_URLHome Assistant URLhttp://homeassistant.10.0.0.19.nip.io:8123
HA_TOKENLong-lived access tokeneyJhbGciOiJIUzI1NiIsInR5cCI...

Optional - Home Assistant

VariableDefaultDescription
HA_PLUGIN_ENABLEDtrueEnable Home Assistant plugin
HA_STRICT_SSLtrueValidate SSL certificates
HA_TIMEOUT30000API request timeout (ms)

Optional - MCP Server

VariableDefaultDescription
MCP_SERVER_LOG_LEVELinfoLog level: debug, info, warn, error
MCP_SERVER_LOG_FORMATplainLog format: plain, json, gcp-json
MCP_SERVER_USE_HTTPfalseEnable HTTP mode (vs stdio)
MCP_SERVER_STATEFULfalseEnable stateful sessions in HTTP mode

Optional - HTTP Mode

VariableDefaultDescription
MCP_HTTP_PORT3000HTTP server port
MCP_HTTP_BIND_ADDR127.0.0.1Bind address
MCP_HTTP_PATH/mcpMCP endpoint path
MCP_HTTP_ENABLE_HEALTHCHECKtrueEnable health check endpoint
MCP_HTTP_HEALTHCHECK_PATH/healthHealth check path
MCP_HTTP_ALLOW_CORStrueEnable CORS
MCP_HTTP_ALLOWED_ORIGINS127.0.0.1,localhostAllowed CORS origins

Optional - SSE Events

VariableDefaultDescription
MCP_SSE_EVENTS_ENABLEDfalseEnable real-time SSE events
MCP_SSE_EVENTS_PATH/subscribe_eventsSSE endpoint path

Optional - Rate Limiting

VariableDefaultDescription
MCP_RATE_LIMIT_ENABLEDfalseEnable rate limiting
MCP_RATE_LIMIT_WINDOW_MS60000Rate limit window (ms)
MCP_RATE_LIMIT_MAX_REQUESTS100Max requests per window

Optional - Authentication

VariableDefaultDescription
MCP_AUTH_METHODnoneAuth method: none or bearer
MCP_AUTH_SECRET-JWT signing secret (min 32 chars, required for bearer method)
MCP_PERMISSIONS_CONFIG-JSON config for user roles and permissions

JWT Authentication

When MCP_AUTH_METHOD=bearer, clients must provide a JWT token in the Authorization header:

Authorization: Bearer <jwt-token>

Generate tokens with your MCP_AUTH_SECRET using HS256 algorithm. The JWT payload should include:

  • sub (subject): User identifier for permission lookup
  • exp (optional): Expiration timestamp

Permission System

The server uses role-based access control with binary permission masks:

PermissionFlagDescription
ADMIN1System operations (restart, updates)
CONFIGURE2Create/modify automations, scripts
CONTROL4Control devices (lights, climate, etc.)
QUERY8Read entity states, history, lists
NOTIFY16Send notifications
AI32Use AI analysis features

Predefined Roles:

RolePermissions
NONENo permissions
READONLYQUERY only
OPERATORQUERY + CONTROL + NOTIFY
CONTRIBUTORQUERY + CONTROL + NOTIFY + CONFIGURE
ADMINAll except AI
SUPERUSERAll permissions

Configuration Example:

{
  "users": [
    { "sub": "admin@example.com", "role": "admin" },
    { "sub": "user@example.com", "role": "operator" },
    { "sub": "viewer@example.com", "role": "readonly" }
  ],
  "defaultRole": "NONE"
}

Set via environment variable (escape quotes for shell):

MCP_PERMISSIONS_CONFIG='{"users":[{"sub":"admin","role":"admin"}],"defaultRole":"NONE"}'

Optional - AI Provider

VariableDefaultDescription
AI_PLUGIN_ENABLEDtrueEnable AI plugin
AI_PROVIDERollamaAI provider: ollama, openai, or none
AI_URLhttp://localhost:11434AI server URL (Ollama)
AI_MODELllama2AI model name
AI_TIMEOUT60000AI request timeout (ms)

Optional - Omada Network Controller

VariableDefaultDescription
OMADA_PLUGIN_ENABLEDfalseEnable Omada plugin
OMADA_BASE_URL-Omada controller URL (e.g., https://192.168.0.1:8043)
OMADA_CLIENT_ID-OAuth2 client ID from Omada controller
OMADA_CLIENT_SECRET-OAuth2 client secret from Omada controller
OMADA_OMADAC_ID-Omada controller ID
OMADA_SITE_ID-Default site ID for operations
OMADA_STRICT_SSLtrueValidate SSL certificates
OMADA_TIMEOUT30000API request timeout (ms)

Advanced Configuration Examples

With AI Analysis (Ollama)

{
  "mcpServers": {
    "homeassistant": {
      "command": "npx",
      "args": ["-y", "@coffeerunhobby/mcp-ha-connect"],
      "env": {
        "HA_URL": "http://homeassistant.10.0.0.19.nip.io:8123",
        "HA_TOKEN": "your_token",
        "AI_PROVIDER": "ollama",
        "AI_URL": "http://ollama.10.0.0.17.nip.io:11434",
        "AI_MODEL": "llama2"
      }
    }
  }
}

Disable AI Features

{
  "mcpServers": {
    "homeassistant": {
      "command": "npx",
      "args": ["-y", "@coffeerunhobby/mcp-ha-connect"],
      "env": {
        "HA_URL": "http://homeassistant.10.0.0.19.nip.io:8123",
        "HA_TOKEN": "your_token",
        "AI_PROVIDER": "none"
      }
    }
  }
}

Docker with Network Configuration

For Linux, you may need to add host.docker.internal:

{
  "mcpServers": {
    "homeassistant": {
      "command": "docker",
      "args": [
        "run",
        "--rm",
        "-i",
        "--add-host=host.docker.internal:host-gateway",
        "-e", "HA_URL=http://host.docker.internal:8123",
        "-e", "HA_TOKEN=your_token",
        "ghcr.io/coffeerunhobby/mcp-ha-connect:latest"
      ]
    }
  }
}

Usage Modes

Mode 1: MCP Client (Claude Desktop / LM Studio)

Default stdio mode for MCP clients. See Quick Start section for configuration.

For detailed configuration options, see docs/LOCAL_CLIENT.md.

Mode 2: HTTP Server

Start as standalone HTTP server for web applications:

# Using npx
npx @coffeerunhobby/mcp-ha-connect

# Or with environment variables
MCP_SERVER_USE_HTTP=true \
MCP_HTTP_PORT=3000 \
HA_URL=http://homeassistant.10.0.0.19.nip.io:8123 \
HA_TOKEN=your_token \
npx @coffeerunhobby/mcp-ha-connect

Streamable HTTP Transport

Configure your MCP client to use:

  • URL: http://localhost:3000/mcp
  • Transport: Streamable HTTP (MCP 2025-03-26)

SSE Event Subscription

Subscribe to real-time events:

const eventSource = new EventSource(
  'http://localhost:3000/subscribe_events?domain=light&entity_id=light.living_room'
);

eventSource.addEventListener('state_changed', (event) => {
  const data = JSON.parse(event.data);
  console.log('Entity changed:', data.entity_id, data.new_state);
});

See docs/SSE_API.md for complete SSE documentation.

Mode 3: Docker Standalone

# Pull image
docker pull ghcr.io/coffeerunhobby/mcp-ha-connect:latest

# Run in HTTP mode
docker run -d --name mcp-ha-connect \
  -e HA_URL=http://homeassistant.10.0.0.19.nip.io:8123 \
  -e HA_TOKEN=your_token \
  -e MCP_SERVER_USE_HTTP=true \
  -p 3000:3000 \
  ghcr.io/coffeerunhobby/mcp-ha-connect:latest

Mode 4: Docker Compose

version: '3.8'

services:
  mcp-ha-connect:
    image: ghcr.io/coffeerunhobby/mcp-ha-connect:latest
    container_name: mcp-ha-connect
    restart: unless-stopped
    ports:
      - "3000:3000"
    environment:
      - HA_URL=http://homeassistant.10.0.0.19.nip.io:8123
      - HA_TOKEN=${HA_TOKEN}
      - MCP_SERVER_USE_HTTP=true
      - MCP_HTTP_BIND_ADDR=0.0.0.0
    networks:
      - home-automation

networks:
  home-automation:
    driver: bridge

Integration Examples

With Claude Desktop

Once configured, you can ask Claude:

  • "Show me all lights in my house"
  • "Turn on the kitchen lights to 50% brightness"
  • "Set the living room temperature to 72 degrees"
  • "Create an automation that turns off all lights at midnight"
  • "What automations are currently enabled?"
  • "Trigger the morning routine automation"
  • "Search for entities with 'bedroom' in their name"
  • "Get all climate entities"
  • "Analyze my sensors for any issues" (requires Ollama)
  • "Check the history of my thermostat"

With n8n Workflows

The server can be integrated with n8n for automated home monitoring. Pre-built workflows are available in the n8n/ directory:

  1. ai-agent-safety-monitor - Critical safety monitoring every 5 minutes

Importing Workflows

Method 1: n8n UI

  1. Open n8n: http://127.0.0.1:5678
  2. Click WorkflowsImport from File
  3. Select JSON file from n8n-files/
  4. Activate the workflow

Method 2: Docker CLI

# Copy workflow to n8n container
docker cp "n8n-files/AI Agent Safety Monitor - Updated.json" n8n:/files/workflow.json

# Import using n8n CLI
docker exec -it n8n n8n import:workflow --input=/files/workflow.json

# Verify import
docker exec -it n8n n8n list:workflow

With Web Applications

Use the HTTP transport with your MCP-compatible web client:

  1. Start server in HTTP mode
  2. Configure client to use http://localhost:3000/mcp
  3. Set transport to Streamable HTTP (MCP 2025-03-26)
  4. Enable CORS by adding your origin to MCP_HTTP_ALLOWED_ORIGINS

With Remote MCP Proxy (uvx)

Connect to a remote MCP server using mcp-remote:

{
  "mcpServers": {
    "homeassistant": {
      "command": "uvx",
      "args": [
        "mcp-remote",
        "http://your-server:3000/mcp"
      ]
    }
  }
}

Network Configuration Notes

  • host.docker.internal - Use this to access services on your host machine from Docker
    • Works on Windows and macOS by default
    • On Linux, add --add-host=host.docker.internal:host-gateway to docker args
  • Direct IP - Use your machine's IP address (e.g., http://10.0.0.19:8123)
  • nip.io domains - Use wildcard DNS for easy local development (e.g., http://homeassistant.10.0.0.19.nip.io:8123)

Security Best Practices

Network Security

  • Network Segmentation: Run MCP server on private LAN only
  • Docker Networks: Use Docker networks for container isolation
  • VLAN: Consider VLAN for IoT devices
  • No Internet Exposure: Never expose MCP server directly to internet

Token & Configuration Security

  • Store .env securely (contains access token)
  • Never commit .env to version control
  • Set .env permissions: chmod 600 .env
  • Use HA_STRICT_SSL=true for HTTPS in production
  • Rotate access tokens periodically
  • Restrict MCP_HTTP_ALLOWED_ORIGINS (avoid wildcard *)
  • Bind to 127.0.0.1 for local-only access
  • Enable rate limiting in production (MCP_RATE_LIMIT_ENABLED=true)

MCP Client Configuration Security

⚠️ Important: Storing tokens directly in MCP client config files (Claude Desktop, LM Studio) exposes them to anyone with filesystem access. Consider:

  • Using .env files with restricted permissions for Docker/local deployments
  • Setting file permissions on config files (e.g., chmod 600)
  • Using environment variable substitution if supported by your client
  • Never committing config files with real tokens to version control

Troubleshooting

Claude Desktop / LM Studio Not Connecting

  1. Check config file location - Verify you're editing the correct file
  2. Restart the application - Close and reopen after config changes
  3. Check logs - Look for error messages in the application logs
  4. Test connection manually:
# Test npx
npx @coffeerunhobby/mcp-ha-connect

# Test Docker
docker run --rm -i \
  -e HA_URL=http://homeassistant.10.0.0.19.nip.io:8123 \
  -e HA_TOKEN=your_token \
  ghcr.io/coffeerunhobby/mcp-ha-connect:latest

Docker host.docker.internal Not Working (Linux)

Add host gateway:

{
  "args": [
    "run",
    "--rm",
    "-i",
    "--add-host=host.docker.internal:host-gateway",
    "-e", "HA_URL=http://host.docker.internal:8123",
    ...
  ]
}

Home Assistant Connection Issues

  1. Verify URL - Try accessing http://your-ha-url:8123/api/ in browser
  2. Check token - Ensure it's a valid long-lived access token
  3. Network access - Verify MCP server can reach Home Assistant
  4. SSL issues - Try HA_STRICT_SSL=false for testing

AI Analysis Not Working

  1. Verify Ollama is running - curl http://your-ollama-url:11434/api/tags
  2. Check model is available - Ensure model is pulled: ollama pull llama2
  3. Set AI_PROVIDER - Must be set to ollama (not none)

Development

Setup

# Clone repository
git clone https://github.com/coffeerunhobby/mcp-ha-connect.git
cd mcp-ha-connect

# Install dependencies
npm install

# Copy environment template
cp .env.example .env

# Edit .env with your Home Assistant details
nano .env

# Build
npm run build

# Run
npm start

Available Scripts

npm run build      # Build TypeScript to dist/
npm run dev        # Run in development mode with watch
npm start          # Run built version
npm test           # Run tests
npm run lint       # Run ESLint
npm run format     # Format code with Prettier

License

MIT

Author

Coffee Run Hobby (github.com/coffeerunhobby)

Links

Documentation

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Related Servers