3e7f3920b2
- Streamline README, API, architecture, and usage documentation - Reduce complexity and focus on core functionality - Update roadmap with more pragmatic, near-term goals - Simplify contributing guidelines - Improve overall documentation clarity and readability
48 lines
1.7 KiB
Markdown
48 lines
1.7 KiB
Markdown
---
|
|
layout: default
|
|
title: Home
|
|
nav_order: 1
|
|
---
|
|
|
|
# 🏠 MCP Server for Home Assistant
|
|
|
|
Welcome to the Model Context Protocol (MCP) Server documentation! This guide will help you get started with integrating a lightweight automation tool with your Home Assistant setup.
|
|
|
|
## 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. |