18f09bb5ce
- Created detailed getting started guide with installation and configuration instructions - Added main documentation README with structured table of contents - Developed troubleshooting guide with common issues, debugging tips, and FAQ - Included development guide with project structure, setup, and contribution guidelines - Added tools documentation with overview of available management tools
60 lines
1.6 KiB
Markdown
60 lines
1.6 KiB
Markdown
# Home Assistant MCP Documentation
|
|
|
|
Welcome to the Home Assistant MCP (Master Control Program) documentation. This documentation provides comprehensive information about setting up, configuring, and using the Home Assistant MCP.
|
|
|
|
## Table of Contents
|
|
|
|
1. [Getting Started](./getting-started.md)
|
|
- Installation
|
|
- Configuration
|
|
- First Steps
|
|
|
|
2. [API Reference](./API.md)
|
|
- REST API Endpoints
|
|
- Authentication
|
|
- Error Handling
|
|
|
|
3. [SSE (Server-Sent Events)](./SSE_API.md)
|
|
- Event Subscriptions
|
|
- Real-time Updates
|
|
- Connection Management
|
|
|
|
4. [Tools](./tools/README.md)
|
|
- Device Control
|
|
- Automation Management
|
|
- Add-on Management
|
|
- Package Management
|
|
|
|
5. [Configuration](./configuration/README.md)
|
|
- Environment Variables
|
|
- Security Settings
|
|
- Performance Tuning
|
|
|
|
6. [Development](./development/README.md)
|
|
- Project Structure
|
|
- Contributing Guidelines
|
|
- Testing
|
|
|
|
7. [Troubleshooting](./troubleshooting.md)
|
|
- Common Issues
|
|
- Debugging
|
|
- FAQ
|
|
|
|
## Quick Links
|
|
|
|
- [GitHub Repository](https://github.com/yourusername/homeassistant-mcp)
|
|
- [Issue Tracker](https://github.com/yourusername/homeassistant-mcp/issues)
|
|
- [Change Log](./CHANGELOG.md)
|
|
- [Security Policy](./SECURITY.md)
|
|
|
|
## Support
|
|
|
|
If you need help or have questions:
|
|
|
|
1. Check the [Troubleshooting Guide](./troubleshooting.md)
|
|
2. Search existing [Issues](https://github.com/yourusername/homeassistant-mcp/issues)
|
|
3. Create a new issue if your problem isn't already reported
|
|
|
|
## License
|
|
|
|
This project is licensed under the MIT License - see the [LICENSE](../LICENSE) file for details. |