Add Smithery CLI installation instructions and badge

This commit is contained in:
Henry Mao
2024-12-23 15:16:51 +07:00
parent 3a11274af1
commit 6f480f1c73

View File

@@ -1,5 +1,8 @@
```markdown
# A Model Context Protocol Server for Home Assistant
[![smithery badge](https://smithery.ai/badge/@strandbrown/homeassistant-mcp)](https://smithery.ai/server/@strandbrown/homeassistant-mcp)
The server uses the MCP protocol to share access to a local Home Assistant instance with an LLM application.
More about MCP here: https://modelcontextprotocol.io/introduction
@@ -8,6 +11,16 @@ More about Home Assistant here: https://www.home-assistant.io
## Usage
### Installing via Smithery
To install Home Assistant Server for Claude Desktop automatically via [Smithery](https://smithery.ai/server/@strandbrown/homeassistant-mcp):
```bash
npx -y @smithery/cli install @strandbrown/homeassistant-mcp --client claude
```
### Manual Installation
First build the server
```
@@ -49,3 +62,4 @@ Get one using this guide: https://community.home-assistant.io/t/how-to-get-long-
- [ ] Testing / writing custom prompts
- [ ] Testing using resources for high-level context
- [ ] Test varying tool organization
```