8b1948ce30
- Refactor index.md with improved navigation and comprehensive documentation sections - Update README.md to streamline documentation navigation - Create new roadmap.md with detailed project goals and vision - Add testing.md with comprehensive testing guidelines and best practices - Improve overall documentation clarity and user experience
87 lines
2.4 KiB
Markdown
87 lines
2.4 KiB
Markdown
---
|
|
layout: default
|
|
title: Home
|
|
nav_order: 1
|
|
---
|
|
|
|
# Model Context Protocol (MCP) Server
|
|
|
|
## Overview
|
|
|
|
The Model Context Protocol (MCP) Server is a cutting-edge bridge between Home Assistant and Language Learning Models (LLMs), designed to revolutionize smart home automation and control. This documentation provides comprehensive information about setting up, configuring, and using the Home Assistant MCP.
|
|
|
|
## Key Features
|
|
|
|
### 🏠 Smart Home Integration
|
|
- Natural language control of smart devices
|
|
- Real-time device state monitoring
|
|
- Advanced automation capabilities
|
|
|
|
### 🤖 LLM Powered Interactions
|
|
- Intuitive voice and text-based commands
|
|
- Context-aware device management
|
|
- Intelligent automation suggestions
|
|
|
|
### 🔒 Security & Performance
|
|
- Token-based authentication
|
|
- High-performance Bun runtime
|
|
- Secure, real-time communication protocols
|
|
|
|
## Documentation
|
|
|
|
### Core Documentation
|
|
1. [Getting Started](getting-started.md)
|
|
- Installation and basic setup
|
|
- Configuration
|
|
- First Steps
|
|
|
|
2. [API Reference](api.md)
|
|
- REST API Endpoints
|
|
- Authentication
|
|
- Error Handling
|
|
|
|
3. [SSE API](sse-api.md)
|
|
- Event Subscriptions
|
|
- Real-time Updates
|
|
- Connection Management
|
|
|
|
### Advanced Topics
|
|
4. [Architecture](architecture.md)
|
|
- System Design
|
|
- Components
|
|
- Data Flow
|
|
|
|
5. [Configuration](getting-started.md#configuration)
|
|
- Environment Variables
|
|
- Security Settings
|
|
- Performance Tuning
|
|
|
|
6. [Development Guide](development/README.md)
|
|
- Project Structure
|
|
- Contributing Guidelines
|
|
- Testing
|
|
|
|
7. [Troubleshooting](troubleshooting.md)
|
|
- Common Issues
|
|
- Debugging
|
|
- FAQ
|
|
|
|
## Quick Links
|
|
|
|
- [GitHub Repository](https://github.com/jango-blockchained/homeassistant-mcp)
|
|
- [Issue Tracker](https://github.com/jango-blockchained/homeassistant-mcp/issues)
|
|
- [Contributing Guide](contributing.md)
|
|
- [Roadmap](roadmap.md)
|
|
|
|
## Community and Support
|
|
|
|
If you need help or have questions:
|
|
|
|
1. Check the [Troubleshooting Guide](troubleshooting.md)
|
|
2. Search existing [Issues](https://github.com/jango-blockchained/homeassistant-mcp/issues)
|
|
3. Join our [GitHub Discussions](https://github.com/jango-blockchained/homeassistant-mcp/discussions)
|
|
4. Create a new issue if your problem isn't already reported
|
|
|
|
## License
|
|
|
|
This project is licensed under the MIT License. See [LICENSE](https://github.com/jango-blockchained/homeassistant-mcp/blob/main/LICENSE) for details. |