alex/homeassistant-mcp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
3e97357561090b38e6643ab9643fa33afa5f9930
homeassistant-mcp/docs
History
jango-blockchained 3e97357561 docs: update documentation to use Bun commands and scripts 
- Replace npm commands with equivalent Bun commands in GETTING_STARTED.md
- Update TESTING.md to reflect Bun-specific test and development scripts
- Simplify installation, development, and testing instructions
2025-02-04 04:17:58 +01:00
..
development
refactor: migrate to Elysia and enhance security middleware
2025-02-04 03:09:35 +01:00
tools
Add comprehensive documentation for Home Assistant MCP project
2025-02-03 15:38:55 +01:00
API.md
refactor: migrate to Elysia and enhance security middleware
2025-02-04 03:09:35 +01:00
ARCHITECTURE.md
docs: add comprehensive architecture documentation for MCP Server
2025-02-04 04:14:43 +01:00
GETTING_STARTED.md
docs: update documentation to use Bun commands and scripts
2025-02-04 04:17:58 +01:00
README.md
Add comprehensive documentation for Home Assistant MCP project
2025-02-03 15:38:55 +01:00
SSE_API.md
Add Server-Sent Events (SSE) API documentation and README updates
2025-01-30 12:21:25 +01:00
TESTING.md
docs: update documentation to use Bun commands and scripts
2025-02-04 04:17:58 +01:00
TROUBLESHOOTING.md
refactor: migrate to Elysia and enhance security middleware
2025-02-04 03:09:35 +01:00

README.md

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

    • Installation
    • Configuration
    • First Steps

  2. API Reference

    • REST API Endpoints
    • Authentication
    • Error Handling

  3. SSE (Server-Sent Events)

    • Event Subscriptions
    • Real-time Updates
    • Connection Management

  4. Tools

    • Device Control
    • Automation Management
    • Add-on Management
    • Package Management

  5. Configuration

    • Environment Variables
    • Security Settings
    • Performance Tuning

  6. Development

    • Project Structure
    • Contributing Guidelines
    • Testing

  7. Troubleshooting

    • Common Issues
    • Debugging
    • FAQ

Quick Links

Support

If you need help or have questions:

  1. Check the Troubleshooting Guide
  2. Search existing 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 file for details.