Files

jango-blockchained 61e930bf8a docs: Refactor documentation structure and enhance project overview

- Update MkDocs configuration with streamlined navigation and theme improvements
- Revise README with comprehensive project introduction and key features
- Add new documentation pages for NLP, custom prompts, and extras
- Enhance index page with system architecture diagram and getting started guide
- Improve overall documentation clarity and organization

2025-02-06 10:06:27 +01:00

3.9 KiB

Raw Blame History

layout, title, nav_order

layout	title	nav_order
default	Home	1

Home Assistant MCP Documentation 🏠🤖

Welcome to the documentation for my Home Assistant MCP (Model Context Protocol) Server. This documentation will help you get started with installation, configuration, and usage of the MCP server.

What is MCP? 🤔

MCP is a lightweight integration tool for Home Assistant that provides:

🔌 REST API for device control
📡 WebSocket/SSE for real-time updates
🤖 AI-powered automation analysis
🎤 Optional speech processing
🔐 Secure authentication

Quick Links 🔗

System Architecture 📊

flowchart TB
    subgraph Client["Client Applications"]
        direction TB
        Web["Web Interface"]
        Mobile["Mobile Apps"]
        Voice["Voice Control"]
    end

    subgraph MCP["MCP Server"]
        direction TB
        API["REST API"]
        WS["WebSocket/SSE"]
        Auth["Authentication"]
        
        subgraph Speech["Speech Processing (Optional)"]
            direction TB
            Wake["Wake Word Detection"]
            STT["Speech-to-Text"]
            
            subgraph STT_Options["STT Options"]
                direction LR
                Whisper["Whisper"]
                FastWhisper["Fast Whisper"]
            end
            
            Wake --> STT
            STT --> STT_Options
        end
    end

    subgraph HA["Home Assistant"]
        direction TB
        HASS_API["HASS API"]
        HASS_WS["HASS WebSocket"]
        Devices["Smart Devices"]
    end

    Client --> MCP
    MCP --> HA
    HA --> Devices

    style Speech fill:#f9f,stroke:#333,stroke-width:2px
    style STT_Options fill:#bbf,stroke:#333,stroke-width:1px

Prerequisites 📋

🚀 Bun runtime (v1.0.26+)
🏡 Home Assistant instance
🐳 Docker (optional, recommended for deployment)
🖥️ Node.js 18+ (optional, for speech features)
🎮 NVIDIA GPU with CUDA support (optional, for faster speech processing)

Why Bun? 🚀

I chose Bun as the runtime for several key benefits:

⚡ Blazing Fast Performance
- Up to 4x faster than Node.js
- Built-in TypeScript support
- Optimized file system operations
🎯 All-in-One Solution
- Package manager (faster than npm/yarn)
- Bundler (no webpack needed)
- Test runner (built-in testing)
- TypeScript transpiler
🔋 Built-in Features
- SQLite3 driver
- .env file loading
- WebSocket client/server
- File watcher
- Test runner

Getting Started 🚀

Check out the Quick Start Guide to begin your journey with Home Assistant MCP!

Key Features

🎮 Device Control

Basic REST API for device management
WebSocket and Server-Sent Events (SSE) for real-time updates
Simple automation rule support

🛡️ Security & Performance

JWT authentication
Basic request validation
Lightweight server design

Documentation Structure

Getting Started

Installation Guide - Set up MCP Server
Quick Start Tutorial - Basic usage examples

Core Documentation

API Documentation - API reference
Architecture Overview - System design
Contributing Guidelines - How to contribute
Troubleshooting Guide - Common issues

Support

Need help or want to report issues?

License

This project is licensed under the MIT License. See the LICENSE file for details.

3.9 KiB Raw Blame History