alex/homeassistant-mcp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
18f09bb5ce19fc0289d0a5dbd8dfa019e88cb425
homeassistant-mcp/docs/tools/README.md
jango-blockchained 18f09bb5ce Add comprehensive documentation for Home Assistant MCP project 
- 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
2025-02-03 15:38:55 +01:00

2.8 KiB
Raw Blame History

Home Assistant MCP Tools

This section documents all available tools in the Home Assistant MCP.

Available Tools

Device Management

  1. List Devices

    • List all available Home Assistant devices
    • Group devices by domain
    • Get device states and attributes

  2. Device Control

    • Control various device types
    • Support for lights, switches, covers, climate devices
    • Domain-specific commands and parameters

History and State

  1. History

    • Fetch device state history
    • Filter by time range
    • Get significant changes

  2. Scene Management

    • List available scenes
    • Activate scenes
    • Scene state information

Automation

  1. Automation Management

    • List automations
    • Toggle automation state
    • Trigger automations manually

  2. Automation Configuration

    • Create new automations
    • Update existing automations
    • Delete automations
    • Duplicate automations

Add-ons and Packages

  1. Add-on Management

    • List available add-ons
    • Install/uninstall add-ons
    • Start/stop/restart add-ons
    • Get add-on information

  2. Package Management

    • Manage HACS packages
    • Install/update/remove packages
    • List available packages by category

Notifications

  1. Notify
    • Send notifications
    • Support for multiple notification services
    • Custom notification data

Real-time Events

  1. Event Subscription

    • Subscribe to Home Assistant events
    • Monitor specific entities
    • Domain-based monitoring

  2. SSE Statistics

    • Get SSE connection statistics
    • Monitor active subscriptions
    • Connection management

Using Tools

All tools can be accessed through:

  1. REST API endpoints
  2. WebSocket connections
  3. Server-Sent Events (SSE)

Authentication

Tools require authentication using:

  • Home Assistant Long-Lived Access Token
  • JWT tokens for specific operations

Error Handling

All tools follow a consistent error handling pattern:

{
    success: boolean;
    message?: string;
    data?: any;
}

Rate Limiting

Tools are subject to rate limiting:

  • Default: 100 requests per 15 minutes
  • Configurable through environment variables

Tool Development

Want to create a new tool? Check out:

Examples

Each tool documentation includes:

  • Usage examples
  • Code snippets
  • Common use cases
  • Troubleshooting tips

Support

Need help with tools?