Skip to main content

Agent for interacting with Home Assistant REST API

Project description

Home Assistant Agent - A2A | AG-UI | MCP

PyPI - Version MCP Server PyPI - Downloads GitHub Repo stars GitHub forks GitHub contributors PyPI - License GitHub

GitHub last commit (by committer) GitHub pull requests GitHub closed pull requests GitHub issues

GitHub top language GitHub language count GitHub repo size GitHub repo file count (file type) PyPI - Wheel PyPI - Implementation

Version: 0.12.0

Overview

Home Assistant Agent MCP Server + A2A Agent

Agent for interacting with Home Assistant REST API

This repository is actively maintained - Contributions are welcome!

MCP

Using as an MCP Server

The MCP Server can be run in two modes: stdio (for local testing) or http (for networked access).

Environment Variables

  • HOME_ASSISTANT_URL: The URL of the target service.
  • HOME_ASSISTANT_TOKEN: The API token or access token.

Run in stdio mode (default):

export HOME_ASSISTANT_URL="http://localhost:8080"
export HOME_ASSISTANT_TOKEN="your_token"
home-assistant-mcp --transport "stdio"

Run in HTTP mode:

export HOME_ASSISTANT_URL="http://localhost:8080"
export HOME_ASSISTANT_TOKEN="your_token"
home-assistant-mcp --transport "http" --host "0.0.0.0" --port "8000"

A2A Agent

Run A2A Server

export HOME_ASSISTANT_URL="http://localhost:8080"
export HOME_ASSISTANT_TOKEN="your_token"
home-assistant-agent --provider openai --model-id gpt-4o --api-key sk-...

Docker

Build

docker build -t home-assistant-agent .

Run MCP Server

docker run -d \
  --name home-assistant-agent \
  -p 8000:8000 \
  -e TRANSPORT=http \
  -e HOME_ASSISTANT_URL="http://your-service:8080" \
  -e HOME_ASSISTANT_TOKEN="your_token" \
  knucklessg1/home-assistant-agent:latest

Deploy with Docker Compose

services:
  home-assistant-agent:
    image: knucklessg1/home-assistant-agent:latest
    environment:
      - HOST=0.0.0.0
      - PORT=8000
      - TRANSPORT=http
      - HOME_ASSISTANT_URL=http://your-service:8080
      - HOME_ASSISTANT_TOKEN=your_token
    ports:
      - 8000:8000

Configure mcp.json for AI Integration (e.g. Claude Desktop)

{
  "mcpServers": {
    "home-assistant": {
      "command": "uv",
      "args": [
        "run",
        "--with",
        "home-assistant-agent",
        "home-assistant-mcp"
      ],
      "env": {
        "HOME_ASSISTANT_URL": "http://your-service:8080",
        "HOME_ASSISTANT_TOKEN": "your_token"
      }
    }
  }
}

Install Python Package

python -m pip install home-assistant-agent
uv pip install home-assistant-agent

Repository Owners

GitHub followers GitHub User's stars

MCP Configuration Examples

1. Standard IO (stdio) Deployment

{
  "mcpServers": {
    "home-assistant-agent": {
      "command": "uv",
      "args": [
        "run",
        "home-assistant-mcp"
      ],
      "env": {
        "AGENT_DESCRIPTION": "<YOUR_AGENT_DESCRIPTION>",
        "AGENT_SYSTEM_PROMPT": "<YOUR_AGENT_SYSTEM_PROMPT>",
        "DEFAULT_AGENT_NAME": "<YOUR_DEFAULT_AGENT_NAME>",
        "HOME_ASSISTANT_AGENT_VERIFY": "<YOUR_HOME_ASSISTANT_AGENT_VERIFY>",
        "HOME_ASSISTANT_TOKEN": "<YOUR_HOME_ASSISTANT_TOKEN>",
        "HOME_ASSISTANT_URL": "<YOUR_HOME_ASSISTANT_URL>"
      }
    }
  }
}

2. Streamable HTTP (SSE) Deployment

{
  "mcpServers": {
    "home-assistant-agent": {
      "command": "uv",
      "args": [
        "run",
        "home-assistant-mcp",
        "--transport",
        "http",
        "--host",
        "0.0.0.0",
        "--port",
        "8000"
      ],
      "env": {
        "AGENT_DESCRIPTION": "<YOUR_AGENT_DESCRIPTION>",
        "AGENT_SYSTEM_PROMPT": "<YOUR_AGENT_SYSTEM_PROMPT>",
        "DEFAULT_AGENT_NAME": "<YOUR_DEFAULT_AGENT_NAME>",
        "HOME_ASSISTANT_AGENT_VERIFY": "<YOUR_HOME_ASSISTANT_AGENT_VERIFY>",
        "HOME_ASSISTANT_TOKEN": "<YOUR_HOME_ASSISTANT_TOKEN>",
        "HOME_ASSISTANT_URL": "<YOUR_HOME_ASSISTANT_URL>"
      }
    }
  }
}

Available MCP Tools

This server utilizes dynamic Action-Routed tools to optimize token overhead and maximize IDE compatibility.

Tool Name Description
ha_calendar Consolidated Action-Routed tool for calendar. Methods: list_calendars, get_calendar_events
ha_config Consolidated Action-Routed tool for config. Methods: status, config, components, check_config
ha_entities Consolidated Action-Routed tool for entities. Methods: get_entity_registry_display, extract_from_target, get_triggers_for_target, get_conditions_for_target, get_services_for_target
ha_events Consolidated Action-Routed tool for events. Methods: list_events, fire_event, subscribe_events
ha_history Consolidated Action-Routed tool for history. Methods: get_history
ha_logbook Consolidated Action-Routed tool for logbook. Methods: get_logbook, get_error_log
ha_panels Consolidated Action-Routed tool for panels. Methods: get_panels
ha_services Consolidated Action-Routed tool for services. Methods: list_services, call_service
ha_states Consolidated Action-Routed tool for states. Methods: list_states, get_state, update_state, delete_state
ha_system Consolidated Action-Routed tool for system. Methods: render_template, ping, handle_intent, validate_config
ha_voice Consolidated Action-Routed tool for voice. Methods: list_exposed_entities, expose_entities

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

home_assistant_agent-0.12.0.tar.gz (18.8 kB view details)

Uploaded Source

Built Distribution

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

home_assistant_agent-0.12.0-py3-none-any.whl (21.2 kB view details)

Uploaded Python 3

File details

Details for the file home_assistant_agent-0.12.0.tar.gz.

File metadata

  • Download URL: home_assistant_agent-0.12.0.tar.gz
  • Upload date:
  • Size: 18.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for home_assistant_agent-0.12.0.tar.gz
Algorithm Hash digest
SHA256 703ee2c0109777fec2b9779651e3b1783f5c01f547f7088cb9030f14e1460ee0
MD5 e96cff15383873db00925c2738d9018d
BLAKE2b-256 331cfba8fededc697b4ed4803ee527bcb7125368caa14eeb8b023f2eb9a48729

See more details on using hashes here.

File details

Details for the file home_assistant_agent-0.12.0-py3-none-any.whl.

File metadata

File hashes

Hashes for home_assistant_agent-0.12.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c37586ef1e2b084ef523291ab555014814aac79df13f196496d8948919f22149
MD5 d3fb8dc5c1510086bc8c13966a219109
BLAKE2b-256 46a67a882f4f3f95ed6e16474668592952068bbb13e81a577a823190ccf806d5

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