Home Assistant Automation MCP Server

# Documentation Index Welcome to the MCP HA Extended documentation. This index helps you navigate all available documentation. ## 📚 Quick Navigation ### For End Users - **[Quick Start Guide](QUICK_START.md)** - Get up and running in 5 minutes - **[Addon Installation](ADDON_INSTALLATION.md)** - Install as a Home Assistant addon - **[Usage Examples](USAGE_EXAMPLES.md)** - See how to use the MCP tools ### For Developers - **[Setup Guide](SETUP.md)** - Detailed development setup instructions - **[PDM Setup](PDM_SETUP.md)** - Python dependency management with PDM - **[Implementation Guide](IMPLEMENTATION_GUIDE.md)** - Technical deep dive into the implementation ### For Addon Maintainers - **[Addon Structure](ADDON_STRUCTURE.md)** - Understanding the addon architecture - **[Addon Build Guide](ADDON_BUILD.md)** - Building and deploying the addon - **[Addon Setup Summary](ADDON_SETUP_SUMMARY.md)** - Overview of addon files and configuration ## 📖 Documentation Overview ### Getting Started | Document | Purpose | Audience | |----------|---------|----------| | [Quick Start Guide](QUICK_START.md) | Fast setup in 5 minutes | End users | | [Setup Guide](SETUP.md) | Detailed setup with troubleshooting | Developers | | [PDM Setup](PDM_SETUP.md) | Python dependency management | Developers | ### Usage | Document | Purpose | Audience | |----------|---------|----------| | [Usage Examples](USAGE_EXAMPLES.md) | Code examples and use cases | All users | | [Implementation Guide](IMPLEMENTATION_GUIDE.md) | Technical implementation details | Developers | ### Home Assistant Addon | Document | Purpose | Audience | |----------|---------|----------| | [Addon Installation](ADDON_INSTALLATION.md) | How to install and configure the addon | End users | | [Addon Structure](ADDON_STRUCTURE.md) | Addon architecture and file structure | Developers | | [Addon Build Guide](ADDON_BUILD.md) | Building and deploying with GitHub Actions | Maintainers | | [Addon Setup Summary](ADDON_SETUP_SUMMARY.md) | Overview of addon components | Developers | ## 🎯 Common Tasks ### I want to... **...use this as a Home Assistant addon** → Start with [Addon Installation](ADDON_INSTALLATION.md) **...develop or modify the code** → Read [Setup Guide](SETUP.md) and [PDM Setup](PDM_SETUP.md) **...understand how it works** → Check [Implementation Guide](IMPLEMENTATION_GUIDE.md) **...see examples** → Browse [Usage Examples](USAGE_EXAMPLES.md) **...build and deploy the addon** → Follow [Addon Build Guide](ADDON_BUILD.md) **...get started quickly** → Jump to [Quick Start Guide](QUICK_START.md) ## 📋 Document Descriptions ### [Quick Start Guide](QUICK_START.md) Fast-track setup guide to get automation management working in 5 minutes. Perfect for first-time users who want to see results quickly. ### [Setup Guide](SETUP.md) Comprehensive setup instructions with detailed steps, troubleshooting tips, and alternative approaches. Essential reading for developers. ### [PDM Setup](PDM_SETUP.md) Guide to using PDM (Python Dependency Manager) for this project. Covers installation, usage, and best practices. ### [Usage Examples](USAGE_EXAMPLES.md) Real-world examples showing how to use each MCP tool. Includes code snippets and expected responses. ### [Implementation Guide](IMPLEMENTATION_GUIDE.md) Technical deep dive into the implementation, architecture decisions, and how the MCP server interacts with Home Assistant's REST API. ### [Addon Installation](ADDON_INSTALLATION.md) Complete guide for installing the MCP server as a Home Assistant addon. Includes configuration, troubleshooting, and usage instructions. ### [Addon Structure](ADDON_STRUCTURE.md) Detailed explanation of the addon's directory structure, key files, build process, and runtime behavior. Essential for understanding how the addon works. ### [Addon Build Guide](ADDON_BUILD.md) Instructions for building and deploying the addon using GitHub Actions. Includes setup for automated builds and GitHub Container Registry integration. ### [Addon Setup Summary](ADDON_SETUP_SUMMARY.md) Overview of all addon-related files, their purposes, and the complete setup process from development to deployment. ## 🔗 Related Resources - **Main README**: See the root [README.md](../README.md) for project overview - **Changelog**: See [CHANGELOG.md](../CHANGELOG.md) for version history - **License**: See [LICENSE](../LICENSE) for licensing information ## 💡 Tips - **New to MCP?** Start with [Quick Start Guide](QUICK_START.md) - **Installing as addon?** Read [Addon Installation](ADDON_INSTALLATION.md) first - **Having issues?** Check the troubleshooting sections in [Setup Guide](SETUP.md) and [Addon Installation](ADDON_INSTALLATION.md) - **Want to contribute?** Read [Implementation Guide](IMPLEMENTATION_GUIDE.md) and [Addon Structure](ADDON_STRUCTURE.md) --- **Need help?** Check the troubleshooting sections in the relevant guides or open an issue on GitHub.