ha-mcp-for-xiaozhi  by c1pher-cn

Home Assistant voice control via AI

Created 1 year ago
254 stars

Top 99.1% on SourcePulse

GitHubView on GitHub
Project Summary

This project provides a Home Assistant integration enabling direct communication with the Xiaozhi AI voice assistant's official servers. It targets Home Assistant users seeking to extend voice control capabilities to their smart home devices via Xiaozhi AI, offering a streamlined, server-less integration path.

How It Works

The integration functions as a WebSocket-based MCP (Message Communication Protocol) server within Home Assistant. It bypasses the need for intermediate servers by directly connecting to Xiaozhi AI's backend. A key design choice allows users to aggregate multiple API groups—including Home Assistant's native control APIs and other user-configured MCP servers—into a single entity, which is then proxied to Xiaozhi AI for unified command processing.

Quick Start & Requirements

  • Installation: Install via HACS (Home Assistant Community Store) by searching for "xiaozhi" or "ha-mcp-for-xiaozhi". Restart Home Assistant after installation.
  • Prerequisites: Home Assistant with HACS installed. Latest Home Assistant versions are recommended for optimal tool availability.
  • Configuration: Add the "MCP Server for Xiaozhi" integration via Settings > Devices & Services. Configure the Xiaozhi MCP access point address and select desired MCPs. Choose between HA's built-in functions (llm_hass_api checkbox) or other configured MCP servers.
  • Links: HACS

Highlighted Details

  • Direct WebSocket connection to Xiaozhi AI official servers, eliminating intermediate hops.
  • Supports consolidating multiple API groups (HA native, custom MCP) into a single entity for proxying.
  • Allows simultaneous configuration of multiple entities for broader control.

Maintenance & Community

The project appears to be a community-driven effort ("powered by love, it's not easy"). No specific details on maintainers, sponsorships, or official community channels (like Discord/Slack) are provided in the README excerpt.

Licensing & Compatibility

The license type is not specified in the provided text. Compatibility for commercial use or linking with closed-source systems is undetermined without a specified license.

Limitations & Caveats

Known issues include potential conflicts between this integration's control logic and Home Assistant's built-in screen and music controls, particularly for lighting and music commands. A resolution is pending future server-side support from Xiaozhi AI for selecting built-in tools. Debugging relies heavily on checking Xiaozhi AI's chat history and enabling plugin-specific logs.

Health Check
Last Commit

9 months ago

Responsiveness

Inactive

Pull Requests (30d)
0
Issues (30d)
0
Star History
14 stars in the last 30 days

Explore Similar Projects

Feedback? Help us improve.