diff --git a/README.md b/README.md new file mode 100644 index 0000000..9f7922b --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +# A Model Context Protocol Server for Home Assistant + +The server uses the MCP protocol to share access to a local Home Assistant instance with an LLM application. + +More about MCP here: + +More about Home Assistant here: + +## Usage + +First build the server + +``` +yarn build +``` + +Then configure your application (like Claude Desktop) to use it. + +``` +{ + "mcpServers": { + "homeassistant": { + "command": "node", + "args": [ + "/Users/tevonsb/Desktop/mcp/dist/index.js" + ], + "env": { + "TOKEN": , + "BASE_URL": + } + } + } +} +``` + +You'll need a personal access token from home assistant. + +Get one using this guide: https://community.home-assistant.io/t/how-to-get-long-lived-access-token/162159