Hekmon8 Homeassistant Server MCP

🚀 Home Assistant MCP Server

This is a Model Context Protocol (MCP) server for interacting with Home Assistant. The server provides tools to control and monitor your home devices through MCP-supported applications.

🚀 Quick Start

The Home Assistant MCP Server is designed to interact seamlessly with Home Assistant, enabling users to control and monitor home devices. It's an integral part of the AI Model Context Protocol (MCP) ecosystem.

✨ Features

• Retrieve device status
• Control device state (on/off)
• Trigger automations
• List available entities

📦 Installation

1. Clone the repository:

git clone https://github.com/yourusername/homeassistant-server-mcp.git
cd homeassistant-server-mcp

2. Install dependencies:

npm install

3. Build the project:

npm run build

4. Configure the MCP server by adding the following to your MCP settings file (usually located at ~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json for VSCode):

{
  "mcpServers": {
    "homeassistant": {
      "command": "node",
      "args": ["/path/to/homeassistant-mcp/homeassistant-server/build/index.js"],
      "env": {
        "HA_URL": "http://your-homeassistant-url:8123",
        "HA_TOKEN": "your-long-lived-access-token"
      }
    }
  }
}

Replace your-homeassistant-url and your-long-lived-access-token with your own Home Assistant instance URL and access token.

💻 Usage Examples

Basic Usage

The server offers the following tools:

1. Get Device Status

// Example usage
use_mcp_tool({
  server_name: "homeassistant",
  tool_name: "get_state",
  arguments: {
    entity_id: "light.living_room"
  }
});

2. Toggle Device State

// Example usage
use_mcp_tool({
  server_name: "homeassistant",
  tool_name: "toggle_entity",
  arguments: {
    entity_id: "switch.bedroom",
    state: "on"  // or "off"
  }
});

3. Trigger Automation

// Example usage
use_mcp_tool({
  server_name: "homeassistant",
  tool_name: "trigger_automation",
  arguments: {
    automation_id: "automation.morning_routine"
  }
});

4. List Entities

// Example usage
use_mcp_tool({
  server_name: "homeassistant",
  tool_name: "list_entities",
  arguments: {
    domain: "light"  // Optional, filter by domain
  }
});

🤝 Contribution

Contributions are welcome! Here's how you can help:

1. Fork the repository
2. Create a feature branch (git checkout -b feature/your-feature-name)
3. Commit your changes and create a pull request

Please ensure you check the code format and write unit tests before submitting.

📚 Documentation

This project utilizes the following technologies and tools:

• Node.js and npm for server building
• Dependency management
• Build system

📄 License

This project is released under the MIT License.

🛠️ Support

If you encounter issues or have questions:

1. Check existing issues in the repository
2. Create a new issue if the problem hasn't been reported
3. Provide as much context as possible to assist with problem-solving
4. Visit www.aimcp.info for more support resources