test: enhance security module with comprehensive token validation and rate limiting tests
- Expanded TokenManager test suite with advanced token encryption and decryption scenarios - Added detailed rate limiting tests with IP-based tracking and window-based expiration - Improved test coverage for token validation, tampering detection, and error handling - Implemented mock configurations for faster test execution - Enhanced security test scenarios with unique IP addresses and edge case handling
This commit is contained in:
jango-blockchained
612
README.md
612
README.md
@@ -1,39 +1,112 @@
|
||||
# Model Context Protocol Server for Home Assistant
|
||||
# Model Context Protocol (MCP) Server for Home Assistant
|
||||
|
||||
The server uses the MCP protocol to share access to a local Home Assistant instance with an LLM application.
|
||||
|
||||
A powerful bridge between your Home Assistant instance and Language Learning Models (LLMs), enabling natural language control and monitoring of your smart home devices through the Model Context Protocol (MCP). This server provides a comprehensive API for managing your entire Home Assistant ecosystem, from device control to system administration.
|
||||
The Model Context Protocol (MCP) Server is a robust, secure, and high-performance bridge that integrates Home Assistant with Language Learning Models (LLMs), enabling natural language control and real-time monitoring of your smart home devices. Unlock advanced automation, control, and analytics for your Home Assistant ecosystem.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Features
|
||||
## Table of Contents
|
||||
|
||||
- 🎮 **Device Control**: Control any Home Assistant device through natural language
|
||||
- 🔄 **Real-time Updates**: Get instant updates through Server-Sent Events (SSE)
|
||||
- 🤖 **Automation Management**: Create, update, and manage automations
|
||||
- 📊 **State Monitoring**: Track and query device states
|
||||
- 🔐 **Secure**: Token-based authentication and rate limiting
|
||||
- 📱 **Mobile Ready**: Works with any HTTP-capable client
|
||||
- [Overview](#overview)
|
||||
- [Key Features](#key-features)
|
||||
- [Architecture & Design](#architecture--design)
|
||||
- [Installation](#installation)
|
||||
- [Basic Setup](#basic-setup)
|
||||
- [Docker Setup (Recommended)](#docker-setup-recommended)
|
||||
- [Usage](#usage)
|
||||
- [API & Documentation](#api--documentation)
|
||||
- [Development](#development)
|
||||
- [Roadmap & Future Plans](#roadmap--future-plans)
|
||||
- [Community & Support](#community--support)
|
||||
- [Contributing](#contributing)
|
||||
- [Troubleshooting & FAQ](#troubleshooting--faq)
|
||||
- [License](#license)
|
||||
|
||||
## Real-time Updates with SSE
|
||||
## Overview
|
||||
|
||||
The server includes a powerful Server-Sent Events (SSE) system that provides real-time updates from your Home Assistant instance. This allows you to:
|
||||
The MCP Server bridges Home Assistant with advanced LLM integrations to deliver intuitive control, automation, and state monitoring. Leveraging a high-performance runtime and real-time communication protocols, MCP offers a seamless experience for managing your smart home.
|
||||
|
||||
- 🔄 Get instant state changes for any device
|
||||
- 📡 Monitor automation triggers and executions
|
||||
- 🎯 Subscribe to specific domains or entities
|
||||
- 📊 Track service calls and script executions
|
||||
## Key Features
|
||||
|
||||
### Quick SSE Example
|
||||
### Device Control & Monitoring
|
||||
- **Smart Device Control:** Manage lights, climate, covers, switches, sensors, media players, fans, locks, vacuums, and cameras using natural language commands.
|
||||
- **Real-time Updates:** Receive instant notifications and updates via Server-Sent Events (SSE).
|
||||
|
||||
### System & Automation Management
|
||||
- **Automation Engine:** Create, modify, and trigger custom automation rules with ease.
|
||||
- **Add-on & Package Management:** Integrates with HACS for deploying custom integrations, themes, scripts, and applications.
|
||||
- **Robust System Management:** Features advanced state monitoring, error handling, and security safeguards.
|
||||
|
||||
## Architecture & Design
|
||||
|
||||
The MCP Server is built with scalability, resilience, and security in mind:
|
||||
|
||||
- **High-Performance Runtime:** Powered by Bun for fast startup, efficient memory utilization, and native TypeScript support.
|
||||
- **Real-time Communication:** Employs Server-Sent Events (SSE) for continuous, real-time data updates.
|
||||
- **Modular & Extensible:** Designed to support plugins, add-ons, and custom automation scripts, allowing for easy expansion.
|
||||
- **Secure API Integration:** Implements token-based authentication, rate limiting, and adherence to best security practices.
|
||||
|
||||
_For a deeper dive into the system architecture, please refer to our [Architecture Documentation](docs/ARCHITECTURE.md) (if available)._
|
||||
|
||||
## Installation
|
||||
|
||||
### Basic Setup
|
||||
|
||||
1. **Install Bun:** If Bun is not installed:
|
||||
```bash
|
||||
curl -fsSL https://bun.sh/install | bash
|
||||
```
|
||||
|
||||
2. **Clone the Repository:**
|
||||
```bash
|
||||
git clone https://github.com/jango-blockchained/homeassistant-mcp.git
|
||||
cd homeassistant-mcp
|
||||
```
|
||||
|
||||
3. **Install Dependencies:**
|
||||
```bash
|
||||
bun install
|
||||
```
|
||||
|
||||
4. **Build the Project:**
|
||||
```bash
|
||||
bun run build
|
||||
```
|
||||
|
||||
### Docker Setup (Recommended)
|
||||
|
||||
1. **Clone the Repository:**
|
||||
```bash
|
||||
git clone https://github.com/jango-blockchained/homeassistant-mcp.git
|
||||
cd homeassistant-mcp
|
||||
```
|
||||
|
||||
2. **Configure Environment:**
|
||||
```bash
|
||||
cp .env.example .env
|
||||
```
|
||||
Customize the `.env` file with your Home Assistant configuration.
|
||||
|
||||
3. **Deploy with Docker Compose:**
|
||||
```bash
|
||||
docker compose up -d
|
||||
```
|
||||
- View logs: `docker compose logs -f`
|
||||
- Stop the server: `docker compose down`
|
||||
|
||||
4. **Update the Application:**
|
||||
```bash
|
||||
git pull && docker compose up -d --build
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Once the server is running, open your browser at [http://localhost:3000](http://localhost:3000). For real-time device updates, integrate the SSE endpoint in your application:
|
||||
|
||||
```javascript
|
||||
const eventSource = new EventSource(
|
||||
'http://localhost:3000/subscribe_events?token=YOUR_TOKEN&domain=light'
|
||||
);
|
||||
const eventSource = new EventSource('http://localhost:3000/subscribe_events?token=YOUR_TOKEN&domain=light');
|
||||
|
||||
eventSource.onmessage = (event) => {
|
||||
const data = JSON.parse(event.data);
|
||||
@@ -41,468 +114,107 @@ eventSource.onmessage = (event) => {
|
||||
};
|
||||
```
|
||||
|
||||
See [SSE_API.md](docs/SSE_API.md) for complete documentation of the SSE system.
|
||||
## API & Documentation
|
||||
|
||||
## Table of Contents
|
||||
Access comprehensive API details and guides in the docs directory:
|
||||
|
||||
- [Key Features](#key-features)
|
||||
- [Prerequisites](#prerequisites)
|
||||
- [Installation](#installation)
|
||||
- [Basic Setup](#basic-setup)
|
||||
- [Docker Setup (Recommended)](#docker-setup-recommended)
|
||||
- [Configuration](#configuration)
|
||||
- [Development](#development)
|
||||
- [API Reference](#api-reference)
|
||||
- [OpenAI Integration](#openai-integration)
|
||||
- [Natural Language Integration](#natural-language-integration)
|
||||
- [Troubleshooting](#troubleshooting)
|
||||
- [Project Status](#project-status)
|
||||
- [Contributing](#contributing)
|
||||
- [Resources](#resources)
|
||||
- [License](#license)
|
||||
|
||||
## Key Features
|
||||
|
||||
### Core Functionality 🎮
|
||||
- **Smart Device Control**
|
||||
- 💡 **Lights**: Brightness, color temperature, RGB color
|
||||
- 🌡️ **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
|
||||
|
||||
### System Management 🛠️
|
||||
- **Add-on Management**
|
||||
- Browse available add-ons
|
||||
- Install/uninstall add-ons
|
||||
- Start/stop/restart add-ons
|
||||
- Version management
|
||||
- Configuration access
|
||||
|
||||
- **Package Management (HACS)**
|
||||
- Integration with Home Assistant Community Store
|
||||
- Multiple package types support:
|
||||
- Custom integrations
|
||||
- Frontend themes
|
||||
- Python scripts
|
||||
- AppDaemon apps
|
||||
- NetDaemon apps
|
||||
- Version control and updates
|
||||
- Repository management
|
||||
|
||||
- **Automation Management**
|
||||
- Create and edit automations
|
||||
- Advanced configuration options:
|
||||
- Multiple trigger types
|
||||
- Complex conditions
|
||||
- Action sequences
|
||||
- Execution modes
|
||||
- Duplicate and modify existing automations
|
||||
- Enable/disable automation rules
|
||||
- Trigger automation manually
|
||||
|
||||
### Architecture Features 🏗️
|
||||
- **Intelligent Organization**
|
||||
- Area and floor-based device grouping
|
||||
- State monitoring and querying
|
||||
- Smart context awareness
|
||||
- Historical data access
|
||||
|
||||
- **Robust Architecture**
|
||||
- Comprehensive error handling
|
||||
- State validation
|
||||
- Secure API integration
|
||||
- TypeScript type safety
|
||||
- Extensive test coverage
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- **Bun** 1.0.26 or higher (Required for optimal performance)
|
||||
- **Docker Compose** for containerization
|
||||
- Running **Home Assistant** instance
|
||||
- Home Assistant long-lived access token ([How to get token](https://community.home-assistant.io/t/how-to-get-long-lived-access-token/162159))
|
||||
- **HACS** installed for package management features
|
||||
- **Supervisor** access for add-on management
|
||||
|
||||
## Installation
|
||||
|
||||
### Basic Setup
|
||||
|
||||
```bash
|
||||
# Install Bun (if not already installed)
|
||||
curl -fsSL https://bun.sh/install | bash
|
||||
|
||||
# Clone the repository
|
||||
git clone https://github.com/jango-blockchained/homeassistant-mcp.git
|
||||
cd homeassistant-mcp
|
||||
|
||||
# Install dependencies
|
||||
bun install
|
||||
|
||||
# Build the project
|
||||
bun run build
|
||||
```
|
||||
|
||||
### Docker Setup (Recommended)
|
||||
|
||||
The project includes Docker support with Bun for optimal performance and consistent environments across different platforms.
|
||||
|
||||
1. **Clone the repository:**
|
||||
```bash
|
||||
git clone https://github.com/jango-blockchained/homeassistant-mcp.git
|
||||
cd homeassistant-mcp
|
||||
```
|
||||
|
||||
2. **Configure environment:**
|
||||
```bash
|
||||
cp .env.example .env
|
||||
```
|
||||
Edit the `.env` file with your Home Assistant configuration:
|
||||
```env
|
||||
# Home Assistant Configuration
|
||||
HASS_HOST=http://homeassistant.local:8123
|
||||
HASS_TOKEN=your_home_assistant_token
|
||||
HASS_SOCKET_URL=ws://homeassistant.local:8123/api/websocket
|
||||
|
||||
# Server Configuration
|
||||
PORT=3000
|
||||
BUN_ENV=production
|
||||
DEBUG=false
|
||||
```
|
||||
|
||||
3. **Build and run with Docker Compose:**
|
||||
```bash
|
||||
# Build and start the containers
|
||||
docker compose up -d
|
||||
|
||||
# View logs
|
||||
docker compose logs -f
|
||||
|
||||
# Stop the service
|
||||
docker compose down
|
||||
```
|
||||
|
||||
4. **Verify the installation:**
|
||||
The server should now be running at `http://localhost:3000`. You can check the health endpoint at `http://localhost:3000/health`.
|
||||
|
||||
5. **Update the application:**
|
||||
```bash
|
||||
# Pull the latest changes
|
||||
git pull
|
||||
|
||||
# Rebuild and restart the containers
|
||||
docker compose up -d --build
|
||||
```
|
||||
|
||||
#### Docker Configuration
|
||||
|
||||
The Docker setup includes:
|
||||
- Multi-stage build using Bun for optimal performance
|
||||
- Health checks for container monitoring
|
||||
- Volume mounting for environment configuration
|
||||
- Automatic container restart on failure
|
||||
- Exposed port 3000 for API access
|
||||
|
||||
#### Docker Compose Environment Variables
|
||||
|
||||
All environment variables can be configured in the `.env` file. The following variables are supported:
|
||||
- `HASS_HOST`: Your Home Assistant instance URL
|
||||
- `HASS_TOKEN`: Long-lived access token for Home Assistant
|
||||
- `HASS_SOCKET_URL`: WebSocket URL for Home Assistant
|
||||
- `PORT`: Server port (default: 3000)
|
||||
- `BUN_ENV`: Environment (production/development)
|
||||
- `DEBUG`: Enable debug mode (true/false)
|
||||
|
||||
## Configuration
|
||||
|
||||
### Environment Variables
|
||||
|
||||
```env
|
||||
# Home Assistant Configuration
|
||||
HASS_HOST=http://homeassistant.local:8123 # Your Home Assistant instance URL
|
||||
HASS_TOKEN=your_home_assistant_token # Long-lived access token
|
||||
HASS_SOCKET_URL=ws://homeassistant.local:8123/api/websocket # WebSocket URL
|
||||
|
||||
# Server Configuration
|
||||
PORT=3000 # Server port (default: 3000)
|
||||
BUN_ENV=production # Environment (production/development)
|
||||
DEBUG=false # Enable debug mode
|
||||
|
||||
# Test Configuration
|
||||
TEST_HASS_HOST=http://localhost:8123 # Test instance URL
|
||||
TEST_HASS_TOKEN=test_token # Test token
|
||||
```
|
||||
|
||||
### Configuration Files
|
||||
|
||||
1. **Development**: Copy `.env.example` to `.env.development`
|
||||
2. **Production**: Copy `.env.example` to `.env.production`
|
||||
3. **Testing**: Copy `.env.example` to `.env.test`
|
||||
- **API Reference:** [API Documentation](docs/API.md)
|
||||
- **SSE Documentation:** [SSE API](docs/SSE_API.md)
|
||||
- **Troubleshooting Guide:** [TROUBLESHOOTING.md](docs/TROUBLESHOOTING.md)
|
||||
- **Architecture Details:** [Architecture Documentation](docs/ARCHITECTURE.md) _(if available)_
|
||||
|
||||
## Development
|
||||
|
||||
### Running in Development Mode
|
||||
|
||||
```bash
|
||||
# Development mode with hot reload and TypeScript watch
|
||||
bun run dev
|
||||
```
|
||||
|
||||
# Run tests with Bun's built-in test runner
|
||||
bun test
|
||||
### Running Tests
|
||||
|
||||
# Run tests with coverage
|
||||
bun test --coverage
|
||||
- Execute all tests:
|
||||
```bash
|
||||
bun test
|
||||
```
|
||||
|
||||
# Build the project
|
||||
- Run tests with coverage:
|
||||
```bash
|
||||
bun test --coverage
|
||||
```
|
||||
|
||||
### Production Build & Start
|
||||
|
||||
```bash
|
||||
bun run build
|
||||
|
||||
# Start the production server
|
||||
bun start
|
||||
```
|
||||
|
||||
## API Reference
|
||||
## Roadmap & Future Plans
|
||||
|
||||
For detailed API documentation, please refer to:
|
||||
- [API Documentation](docs/API.md) - Complete API reference
|
||||
- [SSE API Documentation](docs/SSE_API.md) - Server-Sent Events documentation
|
||||
The MCP Server is under active development and improvement. Planned enhancements include:
|
||||
|
||||
## OpenAI Integration
|
||||
- **Advanced Automation Capabilities:** Introducing more complex automation rules and conditional logic.
|
||||
- **Enhanced Security Features:** Additional authentication layers, encryption enhancements, and security monitoring tools.
|
||||
- **User Interface Improvements:** Development of a more intuitive web dashboard for easier device management.
|
||||
- **Expanded Integrations:** Support for a wider array of smart home devices and third-party services.
|
||||
- **Performance Optimizations:** Continued efforts to reduce latency and improve resource efficiency.
|
||||
|
||||
The server includes powerful AI analysis capabilities powered by OpenAI's GPT-4 model. This feature provides intelligent analysis of your Home Assistant setup through two main modes:
|
||||
_For additional details, check out our [Roadmap](docs/ROADMAP.md) (if available)._
|
||||
|
||||
### 1. Standard Analysis
|
||||
## Community & Support
|
||||
|
||||
Performs a comprehensive system analysis including:
|
||||
- System Overview
|
||||
- Performance Analysis
|
||||
- Security Assessment
|
||||
- Optimization Recommendations
|
||||
- Maintenance Tasks
|
||||
Join our community to stay updated, share ideas, and get help:
|
||||
|
||||
```bash
|
||||
# Run standard analysis
|
||||
bun run test:openai
|
||||
# Select option 1 when prompted
|
||||
```
|
||||
|
||||
### 2. Custom Prompt Analysis
|
||||
|
||||
Allows you to ask specific questions about your Home Assistant setup. The analysis can include:
|
||||
- Device States
|
||||
- Configuration Details
|
||||
- Active Devices
|
||||
- Device Attributes (brightness, temperature, etc.)
|
||||
|
||||
```bash
|
||||
# Run custom analysis
|
||||
bun run test:openai
|
||||
# Select option 2 when prompted
|
||||
```
|
||||
|
||||
### Configuration
|
||||
|
||||
To use the OpenAI integration, you need to set up your OpenAI API key in the `.env` file:
|
||||
```env
|
||||
OPENAI_API_KEY=your_openai_api_key
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Common Issues
|
||||
|
||||
1. **Connection Issues**
|
||||
- Verify Home Assistant is running
|
||||
- Check `HASS_HOST` accessibility
|
||||
- Validate token permissions
|
||||
- Ensure WebSocket connection for real-time updates
|
||||
|
||||
2. **Add-on Management Issues**
|
||||
- Verify Supervisor access
|
||||
- Check add-on compatibility
|
||||
- Validate system resources
|
||||
|
||||
3. **HACS Integration Issues**
|
||||
- Verify HACS installation
|
||||
- Check HACS integration status
|
||||
- Validate repository access
|
||||
|
||||
4. **Automation Issues**
|
||||
- Verify entity availability
|
||||
- Check trigger conditions
|
||||
- Validate service calls
|
||||
- Monitor execution logs
|
||||
|
||||
## Project Status
|
||||
|
||||
### Current Status 🚀
|
||||
|
||||
The project is actively maintained and under continuous development. Recent updates include:
|
||||
|
||||
- ✅ Enhanced Bun runtime optimization
|
||||
- ✅ Improved WebSocket connection management
|
||||
- ✅ Advanced type safety and error handling
|
||||
- ✅ Comprehensive test coverage with Bun's test runner
|
||||
- ✅ Real-time event handling optimization
|
||||
- ✅ Enhanced Docker integration with Bun
|
||||
- ✅ Improved development workflow
|
||||
- ✅ Advanced security features
|
||||
|
||||
### Upcoming Features 🔜
|
||||
|
||||
- 📱 Mobile-first UI improvements with modern frameworks
|
||||
- 🔐 Advanced security features and authentication methods
|
||||
- 🤖 AI-powered automation capabilities
|
||||
- 📊 Real-time analytics and reporting dashboard
|
||||
- 🌐 Multi-instance support with load balancing
|
||||
- 🔄 Enhanced state synchronization
|
||||
- 🎯 Custom automation templates
|
||||
- 🔍 Advanced entity search and filtering
|
||||
- 📈 Performance monitoring tools
|
||||
- 🛠️ Enhanced debugging capabilities
|
||||
|
||||
### Performance Optimizations
|
||||
|
||||
- ⚡ Bun's high-performance JavaScript runtime
|
||||
- 🚀 Optimized WebSocket connections
|
||||
- 📦 Efficient package management with Bun
|
||||
- 🔄 Enhanced state management
|
||||
- 🎯 Targeted event subscriptions
|
||||
- 📊 Memory usage optimizations
|
||||
- 🔍 Query optimization
|
||||
- 🛠️ Development tools integration
|
||||
|
||||
### Version History
|
||||
|
||||
- **v0.2.0** (Current)
|
||||
- Enhanced Bun runtime implementation
|
||||
- Advanced WebSocket management
|
||||
- Improved error handling and recovery
|
||||
- Comprehensive test suite with Bun's test runner
|
||||
- Real-time performance optimizations
|
||||
- Enhanced security features
|
||||
- Advanced automation capabilities
|
||||
- Improved documentation
|
||||
|
||||
- **v0.1.0**
|
||||
- Initial release with Bun support
|
||||
- Basic Home Assistant integration
|
||||
- SSE implementation
|
||||
- Device control capabilities
|
||||
- Basic automation support
|
||||
|
||||
## Performance Benefits with Bun
|
||||
|
||||
This project leverages Bun's high-performance runtime for:
|
||||
|
||||
- 🚀 **Ultra-Fast Execution**: Bun's JavaScript runtime offers superior performance
|
||||
- ⚡ **Quick Development**: Hot reload and TypeScript support out of the box
|
||||
- 📦 **Efficient Package Management**: Lightning-fast installation and dependency resolution
|
||||
- 🧪 **Integrated Testing**: Built-in test runner with superior performance
|
||||
- 🔄 **Native TypeScript Support**: Zero-config TypeScript support
|
||||
- 🎯 **Optimized Build Process**: Faster builds and smaller output
|
||||
- 🛠️ **Development Tools**: Enhanced debugging and profiling
|
||||
- 📊 **Performance Monitoring**: Built-in metrics and diagnostics
|
||||
|
||||
## Development Workflow
|
||||
|
||||
### Testing with Bun
|
||||
|
||||
```bash
|
||||
# Run all tests
|
||||
bun test
|
||||
|
||||
# Run tests in watch mode
|
||||
bun test --watch
|
||||
|
||||
# Run tests with coverage
|
||||
bun test --coverage
|
||||
|
||||
# Run specific test file
|
||||
bun test path/to/test.test.ts
|
||||
```
|
||||
|
||||
### Building with Bun
|
||||
|
||||
```bash
|
||||
# Build the project
|
||||
bun run build
|
||||
|
||||
# Clean and rebuild
|
||||
bun run clean && bun run build
|
||||
```
|
||||
|
||||
### Type Checking
|
||||
|
||||
```bash
|
||||
# Check types
|
||||
bun run types:check
|
||||
|
||||
# Install type definitions
|
||||
bun run types:install
|
||||
```
|
||||
|
||||
### Linting
|
||||
|
||||
```bash
|
||||
# Run ESLint
|
||||
bun run lint
|
||||
|
||||
# Fix linting issues
|
||||
bun run lint:fix
|
||||
```
|
||||
- **GitHub Issues:** Report bugs or suggest features on our [GitHub Issues Page](https://github.com/jango-blockchained/homeassistant-mcp/issues).
|
||||
- **Discussion Forums:** Connect with other users and contributors in our community forums.
|
||||
- **Chat Platforms:** Join our real-time discussions on [Discord](#) or [Slack](#).
|
||||
|
||||
## Contributing
|
||||
|
||||
1. Fork the repository
|
||||
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
|
||||
3. Install dependencies (`bun install`)
|
||||
4. Make your changes
|
||||
5. Run tests (`bun test`)
|
||||
6. Commit your changes (`git commit -m 'Add amazing feature'`)
|
||||
7. Push to the branch (`git push origin feature/amazing-feature`)
|
||||
8. Open a Pull Request
|
||||
We welcome your contributions! To get started:
|
||||
|
||||
## Advanced Features
|
||||
1. Fork the repository.
|
||||
2. Create your feature branch:
|
||||
```bash
|
||||
git checkout -b feature/your-feature-name
|
||||
```
|
||||
3. Install dependencies:
|
||||
```bash
|
||||
bun install
|
||||
```
|
||||
4. Make your changes and run tests:
|
||||
```bash
|
||||
bun test
|
||||
```
|
||||
5. Commit and push your changes, then open a Pull Request.
|
||||
|
||||
### Real-time Monitoring
|
||||
_For detailed guidelines, see [CONTRIBUTING.md](CONTRIBUTING.md)._
|
||||
|
||||
- 📊 Live device state tracking
|
||||
- 🔄 Instant state updates
|
||||
- 📈 Performance metrics
|
||||
- 🎯 Event filtering
|
||||
- 🔍 Advanced search capabilities
|
||||
## Troubleshooting & FAQ
|
||||
|
||||
### Security Features
|
||||
### Common Issues
|
||||
|
||||
- 🔐 Token-based authentication
|
||||
- 🛡️ Rate limiting
|
||||
- 🔒 SSL/TLS support
|
||||
- 👤 User management
|
||||
- 📝 Audit logging
|
||||
- **Connection Problems:** Ensure that your `HASS_HOST`, authentication token, and WebSocket URL are correctly configured.
|
||||
- **Docker Deployment:** Confirm that Docker is running and that your `.env` file contains the correct settings.
|
||||
- **Automation Errors:** Verify entity availability and review your automation configurations for potential issues.
|
||||
|
||||
### Automation Capabilities
|
||||
_For more troubleshooting details, refer to [TROUBLESHOOTING.md](docs/TROUBLESHOOTING.md)._
|
||||
|
||||
- 🤖 Complex automation rules
|
||||
- 📅 Scheduled tasks
|
||||
- 🎯 Conditional triggers
|
||||
- 🔄 State-based actions
|
||||
- 📊 Automation analytics
|
||||
### Frequently Asked Questions
|
||||
|
||||
### Development Tools
|
||||
**Q: What platforms does MCP Server support?**
|
||||
|
||||
- 🛠️ Built-in debugging
|
||||
- 📊 Performance profiling
|
||||
- 🔍 Code analysis
|
||||
- 🧪 Test coverage reports
|
||||
- 📝 Documentation generation
|
||||
A: MCP Server runs on Linux, macOS, and Windows (Docker is recommended for Windows environments).
|
||||
|
||||
## Author
|
||||
**Q: How do I report a bug or request a feature?**
|
||||
|
||||
This project was initiated by [Tevon Strand-Brown](https://github.com/tevonsb) and is mainly developed by [Jango Blockchain](https://github.com/jango-blockchained).
|
||||
A: Please use our [GitHub Issues Page](https://github.com/jango-blockchained/homeassistant-mcp/issues) to report bugs or request new features.
|
||||
|
||||
**Q: Can I contribute to the project?**
|
||||
|
||||
A: Absolutely! We welcome contributions from the community. See the [Contributing](#contributing) section for more details.
|
||||
|
||||
## License
|
||||
|
||||
MIT License - See [LICENSE](LICENSE) file
|
||||
This project is licensed under the MIT License. See [LICENSE](LICENSE) for the full license text.
|
||||
|
||||
Reference in New Issue
Block a user