Openhab MCP

🚀 OpenHAB MCP Server

An MCP (Model Context Protocol) server that interacts with real openHAB instances.

🚀 Quick Start

This project offers an implemented MCP server that connects to real openHAB instances via its REST API. It enables AI assistants like Claude and Cline to interact with your openHAB smart home system.

✨ Features

Item Management

1. list_items - List all openHAB items, optionally filtered by tags.
2. get_item - Retrieve a specific openHAB item by name.
3. create_item - Create a new openHAB item.
4. update_item - Update an existing openHAB item.
5. delete_item - Delete an openHAB item.
6. update_item_state - Update only the state of an openHAB item.

Device Management

7. list_things - List all openHAB devices.
8. get_thing - Retrieve a specific openHAB device by UID.

Rule Management

9. list_rules - List all openHAB rules, optionally filtered by tags.
10. get_rule - Retrieve a specific openHAB rule by UID.
11. create_rule - Create a new openHAB rule.
12. update_rule - Partially update an existing openHAB rule.
13. update_rule_script_action - Update the script action in an openHAB rule.
14. delete_rule - Delete an openHAB rule.
15. run_rule_now - Execute an openHAB rule immediately.

Script Management

16. list_scripts - List all openHAB scripts (rules marked as 'Script' with no triggers).
17. get_script - Retrieve a specific openHAB script by ID.
18. create_script - Create a new openHAB script.
19. update_script - Update an existing openHAB script.
20. delete_script - Delete an openHAB script.

📦 Installation

Environment Requirements

• Python 3.8 or higher

Installation Steps

1. Clone this repository to your local machine:

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

2. Install the dependencies:

   pip install -r requirements.txt
   

3. Configure environment variables or modify the configuration file to set the URL and API key of the OpenHAB server.
4. Run the server:

   python server.py
   

Integration with Claude and Cline

To use this MCP server in Claude or Cline, follow these configuration steps:

For Claude

1. Add the address of the MCP server to the config.json file:

   {
     "mcp_url": "http://localhost:8080"
   }
   

2. Import the MCP tool module in your skills:

   from mcp_tools import *
   

For Cline

1. Update the config.yaml file and add the configuration for the MCP server:

   mcp_server:
     url: http://localhost:8080
   

2. Import the MCP tool module in your scripts:

   from mcp_tools import *
   

Example Question

To test the connection, you can ask Claude/Cline:

Can you list all the items in my OpenHAB system?

If configured correctly, Claude/Cline will use the MCP server to retrieve and display your OpenHAB items.

📚 Documentation

For development, refer to the DEVELOPER.md file for the Docker-based development workflow.

⚠️ Important Note

This implementation connects to real openHAB instances via the REST API. For production use, it is recommended to enhance the following features:

1. More comprehensive error handling and logging.
2. Additional authentication and security features.
3. More complex caching mechanisms.
4. Support for more openHAB functions (rules, devices, etc.).

📄 License

MIT