4fff318ea9
- Update MkDocs configuration with new features and plugins - Add deployment guide for documentation - Restructure documentation navigation and index page - Create GitHub Actions workflow for automatic documentation deployment - Fix typos in site URLs and configuration
57 lines
1.9 KiB
Markdown
57 lines
1.9 KiB
Markdown
---
|
|
layout: default
|
|
title: Home
|
|
nav_order: 1
|
|
---
|
|
|
|
# Advanced Home Assistant MCP
|
|
|
|
Welcome to the Advanced Home Assistant Master Control Program documentation.
|
|
|
|
This documentation provides comprehensive information about setting up, configuring, and using the Advanced Home Assistant MCP system.
|
|
|
|
## Quick Links
|
|
|
|
- [Getting Started](getting-started/index.md)
|
|
- [API Reference](api/index.md)
|
|
- [Configuration Guide](getting-started/configuration.md)
|
|
- [Docker Setup](getting-started/docker.md)
|
|
|
|
## What is MCP Server?
|
|
|
|
MCP Server is a bridge between Home Assistant and custom automation tools, enabling basic device control and real-time monitoring of your smart home environment. It provides a flexible interface for managing and interacting with your home automation setup.
|
|
|
|
## 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](getting-started/installation.md) - Set up MCP Server
|
|
- [Quick Start Tutorial](getting-started/quickstart.md) - Basic usage examples
|
|
|
|
### Core Documentation
|
|
- [API Documentation](api/index.md) - API reference
|
|
- [Architecture Overview](architecture.md) - System design
|
|
- [Contributing Guidelines](contributing.md) - How to contribute
|
|
- [Troubleshooting Guide](troubleshooting.md) - Common issues
|
|
|
|
## Support
|
|
|
|
Need help or want to report issues?
|
|
|
|
- [GitHub Issues](https://github.com/jango-blockchained/homeassistant-mcp/issues)
|
|
- [GitHub Discussions](https://github.com/jango-blockchained/homeassistant-mcp/discussions)
|
|
|
|
## License
|
|
|
|
This project is licensed under the MIT License. See the [LICENSE](https://github.com/jango-blockchained/homeassistant-mcp/blob/main/LICENSE) file for details. |