ci: Enhance documentation deployment workflow with debugging and manual trigger

- Add manual workflow dispatch trigger
- Include diagnostic logging steps for mkdocs build process
- Modify artifact upload path to match project structure
- Add verbose output for build configuration and directory contents

.github/workflows/deploy-docs.yml

@@ -1,4 +1,5 @@
 name: Deploy Documentation
+
 on:
   push:
     branches:
@@ -6,29 +7,70 @@ on:
     paths:
       - 'docs/**'
       - 'mkdocs.yml'
+  # Allow manual trigger
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
 
 jobs:
-  deploy:
+  build:
     runs-on: ubuntu-latest
-    permissions:
-      contents: write
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout repository
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - uses: actions/setup-python@v5
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
         with:
           python-version: '3.x'
           cache: 'pip'
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
           pip install -r docs/requirements.txt
-      - name: Configure Git
+
+      - name: List mkdocs configuration
         run: |
-          git config --global user.name "github-actions[bot]"
-          git config --global user.email "github-actions[bot]@users.noreply.github.com"
-      - name: Build and Deploy
+          echo "Current directory contents:"
+          ls -la
+          echo "MkDocs version:"
+          mkdocs --version
+          echo "MkDocs configuration:"
+          cat mkdocs.yml
+
+      - name: Build documentation
         run: |
           mkdocs build --strict
-          mkdocs gh-deploy --force --clean 
+          echo "Build output contents:"
+          ls -la site/advanced-homeassistant-mcp
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./site/advanced-homeassistant-mcp
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4 

.gitignore

@@ -92,3 +92,10 @@ __pycache__/
 models/
 
 *.code-workspace
+*.ttf
+*.otf
+*.woff
+*.woff2
+*.eot
+*.svg
+*.png

README.md

@@ -12,12 +12,22 @@ MCP (Model Context Protocol) Server is a lightweight integration tool for Home A
 - 📡 WebSocket/Server-Sent Events (SSE) for state updates
 - 🤖 Simple automation rule management
 - 🔐 JWT-based authentication
+- 🎤 Real-time device control and monitoring
+- 🎤 Server-Sent Events (SSE) for live updates
+- 🎤 Comprehensive logging
+- 🎤 Optional speech features:
+  - 🎤 Wake word detection ("hey jarvis", "ok google", "alexa")
+  - 🎤 Speech-to-text using fast-whisper
+  - 🎤 Multiple language support
+  - 🎤 GPU acceleration support
 
 ## Prerequisites 📋
 
 - 🚀 Bun runtime (v1.0.26+)
 - 🏡 Home Assistant instance
-- 🐳 Docker (optional, recommended for deployment)
+- 🐳 Docker (optional, recommended for deployment and speech features)
+- 🖥️ Node.js 18+ (optional, for speech features)
+- 🖥️ NVIDIA GPU with CUDA support (optional, for faster speech processing)
 
 ## Installation 🛠️
 
@@ -30,7 +40,7 @@ cd homeassistant-mcp
 
 # Copy and edit environment configuration
 cp .env.example .env
-# Edit .env with your Home Assistant credentials
+# Edit .env with your Home Assistant credentials and speech features settings
 
 # Build and start containers
 docker compose up -d --build
@@ -79,33 +89,69 @@ ws.onmessage = (event) => {
 };
 ```
 
-## Current Limitations ⚠️
+## Speech Features (Optional)
 
-- 🎙️ Basic voice command support (work in progress)
-- 🧠 Limited advanced NLP capabilities
-- 🔗 Minimal third-party device integration
-- 🐛 Early-stage error handling
+The MCP Server includes optional speech processing capabilities:
 
-## Contributing 🤝
+### Prerequisites
+1. Docker installed and running
+2. NVIDIA GPU with CUDA support (optional)
+3. At least 4GB RAM (8GB+ recommended for larger models)
 
-1. Fork the repository
-2. Create a feature branch:
+### Setup
+
+1. Enable speech features in your .env:
 ```bash
-   git checkout -b feature/your-feature
+ENABLE_SPEECH_FEATURES=true
+ENABLE_WAKE_WORD=true
+ENABLE_SPEECH_TO_TEXT=true
+WHISPER_MODEL_PATH=/models
+WHISPER_MODEL_TYPE=base
 ```
-3. Make your changes
-4. Run tests:
+
+2. Start the speech services:
 ```bash
-   bun test
+docker-compose up -d
 ```
-5. Submit a pull request
 
-## Roadmap 🗺️
+### Available Models
 
-- 🎤 Enhance voice command processing
-- 🔌 Improve device compatibility
-- 🤖 Expand automation capabilities
-- 🛡️ Implement more robust error handling
+Choose a model based on your needs:
+- `tiny.en`: Fastest, basic accuracy
+- `base.en`: Good balance (recommended)
+- `small.en`: Better accuracy, slower
+- `medium.en`: High accuracy, resource intensive
+- `large-v2`: Best accuracy, very resource intensive
+
+### Usage
+
+1. Wake word detection listens for:
+   - "hey jarvis"
+   - "ok google"
+   - "alexa"
+
+2. After wake word detection:
+   - Audio is automatically captured
+   - Speech is transcribed
+   - Commands are processed
+
+3. Manual transcription is also available:
+```typescript
+const speech = speechService.getSpeechToText();
+const text = await speech.transcribe(audioBuffer);
+```
+
+## Configuration
+
+See [Configuration Guide](docs/configuration.md) for detailed settings.
+
+## API Documentation
+
+See [API Documentation](docs/api/index.md) for available endpoints.
+
+## Development
+
+See [Development Guide](docs/development/index.md) for contribution guidelines.
 
 ## License 📄
 

docs/config/index.md

@@ -0,0 +1,30 @@
+# Configuration
+
+This section covers the configuration options available in the Home Assistant MCP Server.
+
+## Overview
+
+The MCP Server can be configured through various configuration files and environment variables. This section will guide you through the available options and their usage.
+
+## Configuration Files
+
+The main configuration files are:
+
+1. `.env` - Environment variables
+2. `config.yaml` - Main configuration file
+3. `devices.yaml` - Device-specific configurations
+
+## Environment Variables
+
+Key environment variables that can be set:
+
+- `MCP_HOST` - Host address (default: 0.0.0.0)
+- `MCP_PORT` - Port number (default: 8123)
+- `MCP_LOG_LEVEL` - Logging level (default: INFO)
+- `MCP_CONFIG_DIR` - Configuration directory path
+
+## Next Steps
+
+- See [System Configuration](../configuration.md) for detailed configuration options
+- Check [Environment Setup](../getting-started/configuration.md) for initial setup
+- Review [Security](../security.md) for security-related configurations 

docs/configuration.md

@@ -0,0 +1,270 @@
+# System Configuration
+
+This document provides detailed information about configuring the Home Assistant MCP Server.
+
+## Configuration File Structure
+
+The MCP Server uses environment variables for configuration, with support for different environments (development, test, production):
+
+```bash
+# .env, .env.development, or .env.test
+PORT=4000
+NODE_ENV=development
+HASS_HOST=http://192.168.178.63:8123
+HASS_TOKEN=your_token_here
+JWT_SECRET=your_secret_key
+```
+
+## Server Settings
+
+### Basic Server Configuration
+- `PORT`: Server port number (default: 4000)
+- `NODE_ENV`: Environment mode (development, production, test)
+- `HASS_HOST`: Home Assistant instance URL
+- `HASS_TOKEN`: Home Assistant long-lived access token
+
+### Security Settings
+- `JWT_SECRET`: Secret key for JWT token generation
+- `RATE_LIMIT`: Rate limiting configuration
+  - `windowMs`: Time window in milliseconds (default: 15 minutes)
+  - `max`: Maximum requests per window (default: 100)
+
+### WebSocket Settings
+- `SSE`: Server-Sent Events configuration
+  - `MAX_CLIENTS`: Maximum concurrent clients (default: 1000)
+  - `PING_INTERVAL`: Keep-alive ping interval in ms (default: 30000)
+
+### Speech Features (Optional)
+- `ENABLE_SPEECH_FEATURES`: Enable speech processing features (default: false)
+- `ENABLE_WAKE_WORD`: Enable wake word detection (default: false)
+- `ENABLE_SPEECH_TO_TEXT`: Enable speech-to-text conversion (default: false)
+- `WHISPER_MODEL_PATH`: Path to Whisper models directory (default: /models)
+- `WHISPER_MODEL_TYPE`: Whisper model type (default: base)
+  - Available models: tiny.en, base.en, small.en, medium.en, large-v2
+
+## Environment Variables
+
+All configuration is managed through environment variables:
+
+```bash
+# Server
+PORT=4000
+NODE_ENV=development
+
+# Home Assistant
+HASS_HOST=http://your-hass-instance:8123
+HASS_TOKEN=your_token_here
+
+# Security
+JWT_SECRET=your-secret-key
+
+# Logging
+LOG_LEVEL=info
+LOG_DIR=logs
+LOG_MAX_SIZE=20m
+LOG_MAX_DAYS=14d
+LOG_COMPRESS=true
+LOG_REQUESTS=true
+
+# Speech Features (Optional)
+ENABLE_SPEECH_FEATURES=false
+ENABLE_WAKE_WORD=false
+ENABLE_SPEECH_TO_TEXT=false
+WHISPER_MODEL_PATH=/models
+WHISPER_MODEL_TYPE=base
+```
+
+## Advanced Configuration
+
+### Security Rate Limiting
+Rate limiting is enabled by default to protect against brute force attacks:
+
+```typescript
+RATE_LIMIT: {
+  windowMs: 15 * 60 * 1000,  // 15 minutes
+  max: 100  // limit each IP to 100 requests per window
+}
+```
+
+### Logging
+The server uses Bun's built-in logging capabilities with additional configuration:
+
+```typescript
+LOGGING: {
+  LEVEL: "info",  // debug, info, warn, error
+  DIR: "logs",
+  MAX_SIZE: "20m",
+  MAX_DAYS: "14d",
+  COMPRESS: true,
+  TIMESTAMP_FORMAT: "YYYY-MM-DD HH:mm:ss:ms",
+  LOG_REQUESTS: true
+}
+```
+
+### Speech-to-Text Configuration
+When speech features are enabled, you can configure the following options:
+
+```typescript
+SPEECH: {
+  ENABLED: false,  // Master switch for all speech features
+  WAKE_WORD_ENABLED: false,  // Enable wake word detection
+  SPEECH_TO_TEXT_ENABLED: false,  // Enable speech-to-text
+  WHISPER_MODEL_PATH: "/models",  // Path to Whisper models
+  WHISPER_MODEL_TYPE: "base",  // Model type to use
+}
+```
+
+Available Whisper models:
+- `tiny.en`: Fastest, lowest accuracy
+- `base.en`: Good balance of speed and accuracy
+- `small.en`: Better accuracy, slower
+- `medium.en`: High accuracy, much slower
+- `large-v2`: Best accuracy, very slow
+
+For production deployments, we recommend using system tools like `logrotate` for log management.
+
+Example logrotate configuration (`/etc/logrotate.d/mcp-server`):
+```
+/var/log/mcp-server.log {
+    daily
+    rotate 7
+    compress
+    delaycompress
+    missingok
+    notifempty
+    create 644 mcp mcp
+}
+```
+
+## Best Practices
+
+1. Always use environment variables for sensitive information
+2. Keep .env files secure and never commit them to version control
+3. Use different environment files for development, test, and production
+4. Enable SSL/TLS in production (preferably via reverse proxy)
+5. Monitor log files for issues
+6. Regularly rotate logs in production
+7. Start with smaller Whisper models and upgrade if needed
+8. Consider GPU acceleration for larger Whisper models
+
+## Validation
+
+The server validates configuration on startup using Zod schemas:
+- Required fields are checked (e.g., HASS_TOKEN)
+- Value types are verified
+- Enums are validated (e.g., LOG_LEVEL, WHISPER_MODEL_TYPE)
+- Default values are applied when not specified
+
+## Troubleshooting
+
+Common configuration issues:
+1. Missing required environment variables
+2. Invalid environment variable values
+3. Permission issues with log directories
+4. Rate limiting too restrictive
+5. Speech model loading failures
+6. Docker not available for speech features
+7. Insufficient system resources for larger models
+
+See the [Troubleshooting Guide](troubleshooting.md) for solutions.
+
+# Configuration Guide
+
+This document describes all available configuration options for the Home Assistant MCP Server.
+
+## Environment Variables
+
+### Required Settings
+
+```bash
+# Server Configuration
+PORT=3000                      # Server port
+HOST=localhost                 # Server host
+
+# Home Assistant
+HASS_URL=http://localhost:8123 # Home Assistant URL
+HASS_TOKEN=your_token         # Long-lived access token
+
+# Security
+JWT_SECRET=your_secret        # JWT signing secret
+```
+
+### Optional Settings
+
+```bash
+# Rate Limiting
+RATE_LIMIT_WINDOW=60000       # Time window in ms (default: 60000)
+RATE_LIMIT_MAX=100           # Max requests per window (default: 100)
+
+# Logging
+LOG_LEVEL=info               # debug, info, warn, error (default: info)
+LOG_DIR=logs                 # Log directory (default: logs)
+LOG_MAX_SIZE=10m            # Max log file size (default: 10m)
+LOG_MAX_FILES=5             # Max number of log files (default: 5)
+
+# WebSocket/SSE
+WS_HEARTBEAT=30000          # WebSocket heartbeat interval in ms (default: 30000)
+SSE_RETRY=3000             # SSE retry interval in ms (default: 3000)
+
+# Speech Features
+ENABLE_SPEECH_FEATURES=false # Enable speech processing (default: false)
+ENABLE_WAKE_WORD=false      # Enable wake word detection (default: false)
+ENABLE_SPEECH_TO_TEXT=false # Enable speech-to-text (default: false)
+
+# Speech Model Configuration
+WHISPER_MODEL_PATH=/models  # Path to whisper models (default: /models)
+WHISPER_MODEL_TYPE=base     # Model type: tiny|base|small|medium|large-v2 (default: base)
+WHISPER_LANGUAGE=en        # Primary language (default: en)
+WHISPER_TASK=transcribe    # Task type: transcribe|translate (default: transcribe)
+WHISPER_DEVICE=cuda        # Processing device: cpu|cuda (default: cuda if available, else cpu)
+
+# Wake Word Configuration
+WAKE_WORDS=hey jarvis,ok google,alexa  # Comma-separated wake words (default: hey jarvis)
+WAKE_WORD_SENSITIVITY=0.5   # Detection sensitivity 0-1 (default: 0.5)
+```
+
+## Speech Features
+
+### Model Selection
+
+Choose a model based on your needs:
+
+| Model      | Size  | Memory Required | Speed | Accuracy |
+|------------|-------|-----------------|-------|----------|
+| tiny.en    | 75MB  | 1GB            | Fast  | Basic    |
+| base.en    | 150MB | 2GB            | Good  | Good     |
+| small.en   | 500MB | 4GB            | Med   | Better   |
+| medium.en  | 1.5GB | 8GB            | Slow  | High     |
+| large-v2   | 3GB   | 16GB           | Slow  | Best     |
+
+### GPU Acceleration
+
+When `WHISPER_DEVICE=cuda`:
+- NVIDIA GPU with CUDA support required
+- Significantly faster processing
+- Higher memory requirements
+
+### Wake Word Detection
+
+- Multiple wake words supported via comma-separated list
+- Adjustable sensitivity (0-1):
+  - Lower values: Fewer false positives, may miss some triggers
+  - Higher values: More responsive, may have false triggers
+  - Default (0.5): Balanced detection
+
+### Best Practices
+
+1. Model Selection:
+   - Start with `base.en` model
+   - Upgrade if better accuracy needed
+   - Downgrade if performance issues
+
+2. Resource Management:
+   - Monitor memory usage
+   - Use GPU acceleration when available
+   - Consider model size vs available resources
+
+3. Wake Word Configuration:
+   - Use distinct wake words
+   - Adjust sensitivity based on environment
+   - Limit number of wake words for better performance 

docs/development/development.md

@@ -1,190 +0,0 @@
-# Development Guide
-
-This guide provides information for developers who want to contribute to or extend the Home Assistant MCP.
-
-## Project Structure
-
-```
-homeassistant-mcp/
-├── src/
-│   ├── __tests__/        # Test files
-│   ├── __mocks__/       # Mock files
-│   ├── api/           # API endpoints and route handlers
-│   ├── config/        # Configuration management
-│   ├── hass/         # Home Assistant integration
-│   ├── interfaces/    # TypeScript interfaces
-│   ├── mcp/          # MCP core functionality
-│   ├── middleware/    # Express middleware
-│   ├── routes/       # Route definitions
-│   ├── security/     # Security utilities
-│   ├── sse/          # Server-Sent Events handling
-│   ├── tools/        # Tool implementations
-│   ├── types/        # TypeScript type definitions
-│   └── utils/        # Utility functions
-├── __tests__/        # Test files
-├── docs/            # Documentation
-├── dist/           # Compiled JavaScript
-└── scripts/        # Build and utility scripts
-```
-
-## Development Setup
-
-1. Install dependencies:
-   ```bash
-   npm install
-   ```
-
-2. Set up development environment:
-   ```bash
-   cp .env.example .env.development
-   ```
-
-3. Start development server:
-   ```bash
-   npm run dev
-   ```
-
-## Code Style
-
-We follow these coding standards:
-
-1. TypeScript best practices
-   - Use strict type checking
-   - Avoid `any` types
-   - Document complex types
-
-2. ESLint rules
-   - Run `npm run lint` to check
-   - Run `npm run lint:fix` to auto-fix
-
-3. Code formatting
-   - Use Prettier
-   - Run `npm run format` to format code
-
-## Testing
-
-1. Unit tests:
-   ```bash
-   npm run test
-   ```
-
-2. Integration tests:
-   ```bash
-   npm run test:integration
-   ```
-
-3. Coverage report:
-   ```bash
-   npm run test:coverage
-   ```
-
-## Creating New Tools
-
-1. Create a new file in `src/tools/`:
-   ```typescript
-   import { z } from 'zod';
-   import { Tool } from '../types';
-
-   export const myTool: Tool = {
-     name: 'my_tool',
-     description: 'Description of my tool',
-     parameters: z.object({
-       // Define parameters
-     }),
-     execute: async (params) => {
-       // Implement tool logic
-     }
-   };
-   ```
-
-2. Add to `src/tools/index.ts`
-3. Create tests in `__tests__/tools/`
-4. Add documentation in `docs/tools/`
-
-## Contributing
-
-1. Fork the repository
-2. Create a feature branch
-3. Make your changes
-4. Write/update tests
-5. Update documentation
-6. Submit a pull request
-
-### Pull Request Process
-
-1. Ensure all tests pass
-2. Update documentation
-3. Update CHANGELOG.md
-4. Get review from maintainers
-
-## Building
-
-1. Development build:
-   ```bash
-   npm run build:dev
-   ```
-
-2. Production build:
-   ```bash
-   npm run build
-   ```
-
-## Documentation
-
-1. Update documentation for changes
-2. Follow documentation structure
-3. Include examples
-4. Update type definitions
-
-## Debugging
-
-1. Development debugging:
-   ```bash
-   npm run dev:debug
-   ```
-
-2. Test debugging:
-   ```bash
-   npm run test:debug
-   ```
-
-3. VSCode launch configurations provided
-
-## Performance
-
-1. Follow performance best practices
-2. Use caching where appropriate
-3. Implement rate limiting
-4. Monitor memory usage
-
-## Security
-
-1. Follow security best practices
-2. Validate all inputs
-3. Use proper authentication
-4. Handle errors securely
-
-## Deployment
-
-1. Build for production:
-   ```bash
-   npm run build
-   ```
-
-2. Start production server:
-   ```bash
-   npm start
-   ```
-
-3. Docker deployment:
-   ```bash
-   docker-compose up -d
-   ```
-
-## Support
-
-Need development help?
-1. Check documentation
-2. Search issues
-3. Create new issue
-4. Join discussions 

docs/development/environment.md

@@ -0,0 +1,197 @@
+# Development Environment Setup
+
+This guide will help you set up your development environment for the Home Assistant MCP Server.
+
+## Prerequisites
+
+### Required Software
+- Python 3.10 or higher
+- pip (Python package manager)
+- git
+- Docker (optional, for containerized development)
+- Node.js 18+ (for frontend development)
+
+### System Requirements
+- 4GB RAM minimum
+- 2 CPU cores minimum
+- 10GB free disk space
+
+## Initial Setup
+
+1. Clone the Repository
+```bash
+git clone https://github.com/jango-blockchained/homeassistant-mcp.git
+cd homeassistant-mcp
+```
+
+2. Create Virtual Environment
+```bash
+python -m venv .venv
+source .venv/bin/activate  # Linux/macOS
+# or
+.venv\Scripts\activate  # Windows
+```
+
+3. Install Dependencies
+```bash
+pip install -r requirements.txt
+pip install -r docs/requirements.txt  # for documentation
+```
+
+## Development Tools
+
+### Code Editor Setup
+We recommend using Visual Studio Code with these extensions:
+- Python
+- Docker
+- YAML
+- ESLint
+- Prettier
+
+### VS Code Settings
+```json
+{
+  "python.linting.enabled": true,
+  "python.linting.pylintEnabled": true,
+  "python.formatting.provider": "black",
+  "editor.formatOnSave": true
+}
+```
+
+## Configuration
+
+1. Create Local Config
+```bash
+cp config.example.yaml config.yaml
+```
+
+2. Set Environment Variables
+```bash
+cp .env.example .env
+# Edit .env with your settings
+```
+
+## Running Tests
+
+### Unit Tests
+```bash
+pytest tests/unit
+```
+
+### Integration Tests
+```bash
+pytest tests/integration
+```
+
+### Coverage Report
+```bash
+pytest --cov=src tests/
+```
+
+## Docker Development
+
+### Build Container
+```bash
+docker build -t mcp-server-dev -f Dockerfile.dev .
+```
+
+### Run Development Container
+```bash
+docker run -it --rm \
+  -v $(pwd):/app \
+  -p 8123:8123 \
+  mcp-server-dev
+```
+
+## Database Setup
+
+### Local Development Database
+```bash
+docker run -d \
+  -p 5432:5432 \
+  -e POSTGRES_USER=mcp \
+  -e POSTGRES_PASSWORD=development \
+  -e POSTGRES_DB=mcp_dev \
+  postgres:14
+```
+
+### Run Migrations
+```bash
+alembic upgrade head
+```
+
+## Frontend Development
+
+1. Install Node.js Dependencies
+```bash
+cd frontend
+npm install
+```
+
+2. Start Development Server
+```bash
+npm run dev
+```
+
+## Documentation
+
+### Build Documentation
+```bash
+mkdocs serve
+```
+
+### View Documentation
+Open http://localhost:8000 in your browser
+
+## Debugging
+
+### VS Code Launch Configuration
+```json
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Python: MCP Server",
+      "type": "python",
+      "request": "launch",
+      "program": "src/main.py",
+      "console": "integratedTerminal"
+    }
+  ]
+}
+```
+
+## Git Hooks
+
+### Install Pre-commit
+```bash
+pip install pre-commit
+pre-commit install
+```
+
+### Available Hooks
+- black (code formatting)
+- flake8 (linting)
+- isort (import sorting)
+- mypy (type checking)
+
+## Troubleshooting
+
+Common Issues:
+1. Port already in use
+   - Check for running processes: `lsof -i :8123`
+   - Kill process if needed: `kill -9 PID`
+
+2. Database connection issues
+   - Verify PostgreSQL is running
+   - Check connection settings in .env
+
+3. Virtual environment problems
+   - Delete and recreate: `rm -rf .venv && python -m venv .venv`
+   - Reinstall dependencies
+
+## Next Steps
+
+1. Review the [Architecture Guide](../architecture.md)
+2. Check [Contributing Guidelines](../contributing.md)
+3. Start with [Simple Issues](https://github.com/jango-blockchained/homeassistant-mcp/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) 

docs/development/index.md

@@ -0,0 +1,54 @@
+# Development Guide
+
+Welcome to the development guide for the Home Assistant MCP Server. This section provides comprehensive information for developers who want to contribute to or extend the project.
+
+## Development Overview
+
+The MCP Server is built with modern development practices in mind, focusing on:
+
+- Clean, maintainable code
+- Comprehensive testing
+- Clear documentation
+- Modular architecture
+
+## Getting Started
+
+1. Set up your development environment
+2. Fork the repository
+3. Install dependencies
+4. Run tests
+5. Make your changes
+6. Submit a pull request
+
+## Development Topics
+
+- [Architecture](../architecture.md) - System architecture and design
+- [Contributing](../contributing.md) - Contribution guidelines
+- [Testing](../testing.md) - Testing framework and guidelines
+- [Troubleshooting](../troubleshooting.md) - Common issues and solutions
+- [Deployment](../deployment.md) - Deployment procedures
+- [Roadmap](../roadmap.md) - Future development plans
+
+## Best Practices
+
+- Follow the coding style guide
+- Write comprehensive tests
+- Document your changes
+- Keep commits atomic
+- Use meaningful commit messages
+
+## Development Workflow
+
+1. Create a feature branch
+2. Make your changes
+3. Run tests
+4. Update documentation
+5. Submit a pull request
+6. Address review comments
+7. Merge when approved
+
+## Next Steps
+
+- Review the [Architecture](../architecture.md)
+- Check [Contributing Guidelines](../contributing.md)
+- Set up your [Development Environment](environment.md) 

docs/features/speech.md

@@ -0,0 +1,212 @@
+# Speech Features
+
+The Home Assistant MCP Server includes powerful speech processing capabilities powered by fast-whisper and custom wake word detection. This guide explains how to set up and use these features effectively.
+
+## Overview
+
+The speech processing system consists of two main components:
+1. Wake Word Detection - Listens for specific trigger phrases
+2. Speech-to-Text - Transcribes spoken commands using fast-whisper
+
+## Setup
+
+### Prerequisites
+
+1. Docker environment:
+```bash
+docker --version  # Should be 20.10.0 or higher
+```
+
+2. For GPU acceleration:
+- NVIDIA GPU with CUDA support
+- NVIDIA Container Toolkit installed
+- NVIDIA drivers 450.80.02 or higher
+
+### Installation
+
+1. Enable speech features in your `.env`:
+```bash
+ENABLE_SPEECH_FEATURES=true
+ENABLE_WAKE_WORD=true
+ENABLE_SPEECH_TO_TEXT=true
+```
+
+2. Configure model settings:
+```bash
+WHISPER_MODEL_PATH=/models
+WHISPER_MODEL_TYPE=base
+WHISPER_LANGUAGE=en
+WHISPER_TASK=transcribe
+WHISPER_DEVICE=cuda  # or cpu
+```
+
+3. Start the services:
+```bash
+docker-compose up -d
+```
+
+## Usage
+
+### Wake Word Detection
+
+The wake word detector continuously listens for configured trigger phrases. Default wake words:
+- "hey jarvis"
+- "ok google"
+- "alexa"
+
+Custom wake words can be configured:
+```bash
+WAKE_WORDS=computer,jarvis,assistant
+```
+
+When a wake word is detected:
+1. The system starts recording audio
+2. Audio is processed through the speech-to-text pipeline
+3. The resulting command is processed by the server
+
+### Speech-to-Text
+
+#### Automatic Transcription
+
+After wake word detection:
+1. Audio is automatically captured (default: 5 seconds)
+2. The audio is transcribed using the configured whisper model
+3. The transcribed text is processed as a command
+
+#### Manual Transcription
+
+You can also manually transcribe audio using the API:
+
+```typescript
+// Using the TypeScript client
+import { SpeechService } from '@ha-mcp/client';
+
+const speech = new SpeechService();
+
+// Transcribe from audio buffer
+const buffer = await getAudioBuffer();
+const text = await speech.transcribe(buffer);
+
+// Transcribe from file
+const text = await speech.transcribeFile('command.wav');
+```
+
+```javascript
+// Using the REST API
+POST /api/speech/transcribe
+Content-Type: multipart/form-data
+
+file: <audio file>
+```
+
+### Event Handling
+
+The system emits various events during speech processing:
+
+```typescript
+speech.on('wakeWord', (word: string) => {
+  console.log(`Wake word detected: ${word}`);
+});
+
+speech.on('listening', () => {
+  console.log('Listening for command...');
+});
+
+speech.on('transcribing', () => {
+  console.log('Processing speech...');
+});
+
+speech.on('transcribed', (text: string) => {
+  console.log(`Transcribed text: ${text}`);
+});
+
+speech.on('error', (error: Error) => {
+  console.error('Speech processing error:', error);
+});
+```
+
+## Performance Optimization
+
+### Model Selection
+
+Choose an appropriate model based on your needs:
+
+1. Resource-constrained environments:
+   - Use `tiny.en` or `base.en`
+   - Run on CPU if GPU unavailable
+   - Limit concurrent processing
+
+2. High-accuracy requirements:
+   - Use `small.en` or `medium.en`
+   - Enable GPU acceleration
+   - Increase audio quality
+
+3. Production environments:
+   - Use `base.en` or `small.en`
+   - Enable GPU acceleration
+   - Configure appropriate timeouts
+
+### GPU Acceleration
+
+When using GPU acceleration:
+
+1. Monitor GPU memory usage:
+```bash
+nvidia-smi -l 1
+```
+
+2. Adjust model size if needed:
+```bash
+WHISPER_MODEL_TYPE=small  # Decrease if GPU memory limited
+```
+
+3. Configure processing device:
+```bash
+WHISPER_DEVICE=cuda      # Use GPU
+WHISPER_DEVICE=cpu      # Use CPU if GPU unavailable
+```
+
+## Troubleshooting
+
+### Common Issues
+
+1. Wake word detection not working:
+   - Check microphone permissions
+   - Adjust `WAKE_WORD_SENSITIVITY`
+   - Verify wake words configuration
+
+2. Poor transcription quality:
+   - Check audio input quality
+   - Try a larger model
+   - Verify language settings
+
+3. Performance issues:
+   - Monitor resource usage
+   - Consider smaller model
+   - Check GPU acceleration status
+
+### Logging
+
+Enable debug logging for detailed information:
+```bash
+LOG_LEVEL=debug
+```
+
+Speech-specific logs will be tagged with `[SPEECH]` prefix.
+
+## Security Considerations
+
+1. Audio Privacy:
+   - Audio is processed locally
+   - No data sent to external services
+   - Temporary files automatically cleaned
+
+2. Access Control:
+   - Speech endpoints require authentication
+   - Rate limiting applies to transcription
+   - Configurable command restrictions
+
+3. Resource Protection:
+   - Timeouts prevent hanging
+   - Memory limits enforced
+   - Graceful error handling 

docs/getting-started.md

@@ -1,30 +0,0 @@
-# Getting Started
-
-Begin your journey with the Home Assistant MCP Server by following these steps:
-
-- **API Documentation:** Read the [API Documentation](api.md) for available endpoints.
-- **Real-Time Updates:** Learn about [Server-Sent Events](api/sse.md) for live communication.
-- **Tools:** Explore available [Tools](tools/tools.md) for device control and automation.
-- **Configuration:** Refer to the [Configuration Guide](getting-started/configuration.md) for setup and advanced settings.
-
-## Troubleshooting
-
-If you encounter any issues:
-1. Verify that your Home Assistant instance is accessible.
-2. Ensure that all required environment variables are properly set.
-3. Consult the [Troubleshooting Guide](troubleshooting.md) for additional solutions.
-
-## Development
-
-For contributors:
-1. Fork the repository.
-2. Create a feature branch.
-3. Follow the [Development Guide](development/development.md) for contribution guidelines.
-4. Submit a pull request with your enhancements.
-
-## Support
-
-Need help?
-- Visit our [GitHub Issues](https://github.com/jango-blockchained/homeassistant-mcp/issues).
-- Review the [Troubleshooting Guide](troubleshooting.md).
-- Check the [FAQ](troubleshooting.md#faq) for common questions. 

docs/requirements.txt

@@ -6,7 +6,6 @@ mkdocs-material>=9.5.3
 mkdocs-minify-plugin>=0.7.1
 mkdocs-git-revision-date-localized-plugin>=1.2.1
 mkdocs-glightbox>=0.3.4
-mkdocs-optimize>=0.1.1
 mkdocs-git-authors-plugin>=0.7.2
 mkdocs-git-committers-plugin>=0.2.3
 mkdocs-static-i18n>=1.2.0
@@ -16,8 +15,6 @@ mkdocs-include-markdown-plugin>=6.0.4
 mkdocs-macros-plugin>=1.0.4
 mkdocs-meta-descriptions-plugin>=3.0.0
 mkdocs-print-site-plugin>=2.3.6
-mkdocs-pdf-export-plugin>=0.5.10
-mkdocs-with-pdf>=0.9.3
 
 # Code Documentation
 mkdocstrings>=0.24.0

docs/security.md

@@ -0,0 +1,146 @@
+# Security Guide
+
+This document outlines security best practices and configurations for the Home Assistant MCP Server.
+
+## Authentication
+
+### JWT Authentication
+The server uses JWT (JSON Web Tokens) for API authentication:
+
+```http
+Authorization: Bearer YOUR_JWT_TOKEN
+```
+
+### Token Configuration
+```yaml
+security:
+  jwt_secret: YOUR_SECRET_KEY
+  token_expiry: 24h
+  refresh_token_expiry: 7d
+```
+
+## Access Control
+
+### CORS Configuration
+Configure allowed origins to prevent unauthorized access:
+
+```yaml
+security:
+  allowed_origins:
+    - http://localhost:3000
+    - https://your-domain.com
+```
+
+### IP Filtering
+Restrict access by IP address:
+
+```yaml
+security:
+  allowed_ips:
+    - 192.168.1.0/24
+    - 10.0.0.0/8
+```
+
+## SSL/TLS Configuration
+
+### Enable HTTPS
+```yaml
+ssl:
+  enabled: true
+  cert_file: /path/to/cert.pem
+  key_file: /path/to/key.pem
+```
+
+### Certificate Management
+1. Use Let's Encrypt for free SSL certificates
+2. Regularly renew certificates
+3. Monitor certificate expiration
+
+## Rate Limiting
+
+### Basic Rate Limiting
+```yaml
+rate_limit:
+  enabled: true
+  requests_per_minute: 100
+  burst: 20
+```
+
+### Advanced Rate Limiting
+```yaml
+rate_limit:
+  rules:
+    - endpoint: /api/control
+      requests_per_minute: 50
+    - endpoint: /api/state
+      requests_per_minute: 200
+```
+
+## Data Protection
+
+### Sensitive Data
+- Use environment variables for secrets
+- Encrypt sensitive data at rest
+- Implement secure backup procedures
+
+### Logging Security
+- Avoid logging sensitive information
+- Rotate logs regularly
+- Protect log file access
+
+## Best Practices
+
+1. Regular Security Updates
+   - Keep dependencies updated
+   - Monitor security advisories
+   - Apply patches promptly
+
+2. Password Policies
+   - Enforce strong passwords
+   - Implement password expiration
+   - Use secure password storage
+
+3. Monitoring
+   - Log security events
+   - Monitor access patterns
+   - Set up alerts for suspicious activity
+
+4. Network Security
+   - Use VPN for remote access
+   - Implement network segmentation
+   - Configure firewalls properly
+
+## Security Checklist
+
+- [ ] Configure SSL/TLS
+- [ ] Set up JWT authentication
+- [ ] Configure CORS properly
+- [ ] Enable rate limiting
+- [ ] Implement IP filtering
+- [ ] Secure sensitive data
+- [ ] Set up monitoring
+- [ ] Configure backup encryption
+- [ ] Update security policies
+
+## Incident Response
+
+1. Detection
+   - Monitor security logs
+   - Set up intrusion detection
+   - Configure alerts
+
+2. Response
+   - Document incident details
+   - Isolate affected systems
+   - Investigate root cause
+
+3. Recovery
+   - Apply security fixes
+   - Restore from backups
+   - Update security measures
+
+## Additional Resources
+
+- [Security Best Practices](https://owasp.org/www-project-top-ten/)
+- [JWT Security](https://jwt.io/introduction)
+- [SSL Configuration](https://ssl-config.mozilla.org/) 

docs/tools/index.md

@@ -0,0 +1,42 @@
+# Tools Overview
+
+The Home Assistant MCP Server provides a variety of tools to help you manage and interact with your home automation system.
+
+## Available Tools
+
+### Device Management
+- [List Devices](device-management/list-devices.md) - View and manage connected devices
+- [Device Control](device-management/control.md) - Control device states and settings
+
+### History & State
+- [History](history-state/history.md) - View and analyze historical data
+- [Scene Management](history-state/scene.md) - Create and manage scenes
+
+### Automation
+- [Automation Management](automation/automation.md) - Create and manage automations
+- [Automation Configuration](automation/automation-config.md) - Configure automation settings
+
+### Add-ons & Packages
+- [Add-on Management](addons-packages/addon.md) - Manage server add-ons
+- [Package Management](addons-packages/package.md) - Handle package installations
+
+### Notifications
+- [Notify](notifications/notify.md) - Send and manage notifications
+
+### Events
+- [Event Subscription](events/subscribe-events.md) - Subscribe to system events
+- [SSE Statistics](events/sse-stats.md) - Monitor Server-Sent Events statistics
+
+## Getting Started
+
+To get started with these tools:
+
+1. Ensure you have the MCP Server properly installed and configured
+2. Check the specific tool documentation for detailed usage instructions
+3. Use the API endpoints or command-line interface as needed
+
+## Next Steps
+
+- Review the [API Documentation](../api/index.md) for programmatic access
+- Check [Configuration](../config/index.md) for tool-specific settings
+- See [Examples](../examples/index.md) for practical use cases 

docs/tools/tools.md

@@ -1,127 +0,0 @@
-# Home Assistant MCP Tools
-
-This section documents all available tools in the Home Assistant MCP.
-
-## Available Tools
-
-### Device Management
-
-1. [List Devices](device-management/list-devices.md)
-   - List all available Home Assistant devices
-   - Group devices by domain
-   - Get device states and attributes
-
-2. [Device Control](device-management/control.md)
-   - Control various device types
-   - Support for lights, switches, covers, climate devices
-   - Domain-specific commands and parameters
-
-### History and State
-
-1. [History](history-state/history.md)
-   - Fetch device state history
-   - Filter by time range
-   - Get significant changes
-
-2. [Scene Management](history-state/scene.md)
-   - List available scenes
-   - Activate scenes
-   - Scene state information
-
-### Automation
-
-1. [Automation Management](automation/automation.md)
-   - List automations
-   - Toggle automation state
-   - Trigger automations manually
-
-2. [Automation Configuration](automation/automation-config.md)
-   - Create new automations
-   - Update existing automations
-   - Delete automations
-   - Duplicate automations
-
-### Add-ons and Packages
-
-1. [Add-on Management](addons-packages/addon.md)
-   - List available add-ons
-   - Install/uninstall add-ons
-   - Start/stop/restart add-ons
-   - Get add-on information
-
-2. [Package Management](addons-packages/package.md)
-   - Manage HACS packages
-   - Install/update/remove packages
-   - List available packages by category
-
-### Notifications
-
-1. [Notify](notifications/notify.md)
-   - Send notifications
-   - Support for multiple notification services
-   - Custom notification data
-
-### Real-time Events
-
-1. [Event Subscription](events/subscribe-events.md)
-   - Subscribe to Home Assistant events
-   - Monitor specific entities
-   - Domain-based monitoring
-
-2. [SSE Statistics](events/sse-stats.md)
-   - Get SSE connection statistics
-   - Monitor active subscriptions
-   - Connection management
-
-## Using Tools
-
-All tools can be accessed through:
-
-1. REST API endpoints
-2. WebSocket connections
-3. Server-Sent Events (SSE)
-
-### Authentication
-
-Tools require authentication using:
-- Home Assistant Long-Lived Access Token
-- JWT tokens for specific operations
-
-### Error Handling
-
-All tools follow a consistent error handling pattern:
-```typescript
-{
-    success: boolean;
-    message?: string;
-    data?: any;
-}
-```
-
-### Rate Limiting
-
-Tools are subject to rate limiting:
-- Default: 100 requests per 15 minutes
-- Configurable through environment variables
-
-## Tool Development
-
-Want to create a new tool? Check out:
-- [Tool Development Guide](../development/tools.md)
-- [Tool Interface Documentation](../development/interfaces.md)
-- [Best Practices](../development/best-practices.md)
-
-## Examples
-
-Each tool documentation includes:
-- Usage examples
-- Code snippets
-- Common use cases
-- Troubleshooting tips
-
-## Support
-
-Need help with tools?
-- Check individual tool documentation
-- See [Troubleshooting Guide](../troubleshooting.md)
-- Create an issue on GitHub 

mkdocs.yml

@@ -107,8 +107,8 @@ markdown_extensions:
   - attr_list
   - md_in_html
   - pymdownx.emoji:
-      emoji_index: !!python/name:materialx.emoji.twemoji
-      emoji_generator: !!python/name:materialx.emoji.to_svg
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
   - footnotes
   - tables
   - def_list
@@ -124,36 +124,15 @@ plugins:
   
   # Advanced Features
   - social:
-      cards: true
-      cards_color:
-        fill: "#1e1e2e"
-        text: "#cdd6f4"
+      cards: false
   - tags
   - offline
-  - optimize
   
   # Version Management
   - git-revision-date-localized:
       enable_creation_date: true
       type: date
 
-  # Analytics
-  - analytics:
-      provider: google
-      feedback:
-        title: Was this page helpful?
-        ratings:
-          - icon: material/emoticon-happy-outline
-            name: This page was helpful
-            data: 1
-            note: >-
-              Thanks for your feedback!
-          - icon: material/emoticon-sad-outline
-            name: This page could be improved
-            data: 0
-            note: >- 
-              Thanks for your feedback!
-
 extra:
   # Consent Management
   consent:
@@ -196,9 +175,13 @@ extra:
         - icon: material/emoticon-happy-outline
           name: This page was helpful
           data: 1
+          note: >-
+            Thanks for your feedback!
         - icon: material/emoticon-sad-outline
           name: This page could be improved
           data: 0
+          note: >-
+            Thanks for your feedback! Please consider creating an issue to help us improve.
 
 extra_css:
   - stylesheets/extra.css
@@ -224,11 +207,14 @@ nav:
     - Overview: api/index.md
     - Core API: api/core.md
     - SSE API: api/sse.md
+    - API Documentation: api.md
   - Usage: usage.md
   - Configuration:
+    - Overview: config/index.md
     - System Configuration: configuration.md
+    - Security: security.md
   - Tools:
-    - Overview: tools/tools.md
+    - Overview: tools/index.md
     - Device Management:
       - List Devices: tools/device-management/list-devices.md
       - Device Control: tools/device-management/control.md
@@ -247,16 +233,17 @@ nav:
       - Event Subscription: tools/events/subscribe-events.md
       - SSE Statistics: tools/events/sse-stats.md
   - Development:
-    - Overview: development/development.md
+    - Overview: development/index.md
+    - Environment Setup: development/environment.md
+    - Architecture: architecture.md
+    - Contributing: contributing.md
+    - Testing: testing.md
     - Best Practices: development/best-practices.md
     - Interfaces: development/interfaces.md
     - Tool Development: development/tools.md
-    - Testing Guide: development/test-migration-guide.md
-    - Testing: testing.md
-    - Deployment Guide: deployment.md
-  - Architecture: architecture.md
-  - Contributing: contributing.md
+    - Test Migration Guide: development/test-migration-guide.md
     - Troubleshooting: troubleshooting.md
+    - Deployment: deployment.md
+    - Roadmap: roadmap.md
   - Examples:
     - Overview: examples/index.md
-  - Roadmap: roadmap.md