Skip to content

Commit fd8f68d

Browse files
authored
docs: simplifies the installation instructions
Pull Request Overview This PR simplifies the installation instructions by removing Git as a prerequisite and updating uvx commands to use the PyPI package directly instead of Git URLs. Since the package is published to PyPI (as evidenced by the pypi-publish.yml workflow), Git is only needed for testing unpublished changes from feature branches, which is now properly documented in the tests README. Removed Git from installation prerequisites across all documentation Updated all uvx commands to use the simpler package name syntax instead of Git URLs Added comprehensive manual branch testing instructions for developers who need to test unpublished changes
1 parent 125c934 commit fd8f68d

3 files changed

Lines changed: 32 additions & 10 deletions

File tree

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -189,9 +189,9 @@ claude mcp add-json home-assistant '{
189189
> **Windows users:** Follow the [Windows UV setup guide](docs/Windows-uv-guide.md)
190190
191191
**Prerequisites:**
192-
- [UV package manager](https://docs.astral.sh/uv/getting-started/installation/) and [Git binary](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
193-
- Windows: winget install astral-sh.uv Git.Git -e
194-
- MacOS: brew install git uv
192+
- [UV package manager](https://docs.astral.sh/uv/getting-started/installation/)
193+
- Windows: winget install astral-sh.uv -e
194+
- MacOS: brew install uv
195195
- Your Home assistant URL (ex: http://localhost:8123) for HOMEASSISTANT_URL variable
196196
- A Home Assistant long-lived access token (Profile → Security → Long-Lived Access Tokens) for HOMEASSISTANT_TOKEN variable
197197

@@ -209,7 +209,7 @@ claude mcp add-json home-assistant '{
209209
"mcpServers": {
210210
"Home Assistant": {
211211
"command": "uvx",
212-
"args": ["--from=git+https://github.com/homeassistant-ai/ha-mcp", "ha-mcp"],
212+
"args": ["ha-mcp"],
213213
"env": {
214214
"HOMEASSISTANT_URL": "http://localhost:8123",
215215
"HOMEASSISTANT_TOKEN": "your_long_lived_token"
@@ -229,7 +229,7 @@ Note: replace both HOMEASSISTANT_URL and HOMEASSISTANT_TOKEN with your values.
229229
claude mcp add --transport stdio home-assistant \
230230
--env HOMEASSISTANT_URL=http://localhost:8123 \
231231
--env HOMEASSISTANT_TOKEN=your_long_lived_token \
232-
-- uvx --from=git+https://github.com/homeassistant-ai/ha-mcp ha-mcp
232+
-- uvx ha-mcp
233233
```
234234

235235
</details>
@@ -245,15 +245,15 @@ set HOMEASSISTANT_URL=http://localhost:8123
245245
set HOMEASSISTANT_TOKEN=your_long_lived_token
246246
set MCP_PORT=8086
247247
set MCP_SECRET_PATH=/__my_secret__
248-
uvx --from=git+https://github.com/homeassistant-ai/ha-mcp ha-mcp-web
248+
uvx --from ha-mcp ha-mcp-web
249249
```
250250
Others:
251251
```bash
252252
export HOMEASSISTANT_URL=http://localhost:8123
253253
export HOMEASSISTANT_TOKEN=your_long_lived_token
254254
export MCP_PORT=8086
255255
export MCP_SECRET_PATH=/__my_secret__
256-
uvx --from=git+https://github.com/homeassistant-ai/ha-mcp ha-mcp-web
256+
uvx --from ha-mcp ha-mcp-web
257257
```
258258

259259
Web client required https and a public URL. You need to use a proxy in front of `http://localhost:8086`.

docs/Windows-uv-guide.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ _Based on steps shared by @kingbear2._
44

55
This guide walks through running the ha-mcp server locally on Windows with Claude using the [uv](https://docs.astral.sh/uv/) package manager. Expect the process to take about 10 minutes.
66

7-
## 1. Install uv and git
7+
## 1. Install uv
88

99
Open **PowerShell** or **cmd** and run:
1010

1111
```powershell
12-
winget install astral-sh.uv Git.Git -e
12+
winget install astral-sh.uv -e
1313
```
1414

1515
## 2. Configure Claude Desktop
@@ -22,7 +22,7 @@ winget install astral-sh.uv Git.Git -e
2222
"mcpServers": {
2323
"Home Assistant": {
2424
"command": "uvx",
25-
"args": ["--from=git+https://github.com/homeassistant-ai/ha-mcp", "ha-mcp"],
25+
"args": ["ha-mcp"],
2626
"env": {
2727
"HOMEASSISTANT_URL": "http://homeassistant.local:8123",
2828
"HOMEASSISTANT_TOKEN": "your_long_lived_token"

tests/README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,28 @@ uv run pytest tests/src/e2e/basic/ -v # Basic connectivity
3333
uv run pytest tests/src/e2e/workflows/automation/ -v # Automation tests
3434
```
3535

36+
### Manual Branch Testing
37+
38+
Need to validate unpublished changes from a feature branch? Use `uvx` with the
39+
Git URL so you can run the project directly from that branch:
40+
41+
```bash
42+
# FastMCP STDIO entry point
43+
uvx --from git+https://github.com/homeassistant-ai/ha-mcp.git@branchname ha-mcp
44+
45+
# FastMCP HTTP server
46+
uvx --from git+https://github.com/homeassistant-ai/ha-mcp.git@branchname ha-mcp-web
47+
```
48+
49+
Replace `branchname` with the branch you want to exercise (for example,
50+
`feature/manual-test-instructions`). If you are working from a fork, swap
51+
`homeassistant-ai` with your GitHub username to target your repository in both
52+
commands. When using these commands, adapt the corresponding `uvx` setup in
53+
[README.md → Method 3: Running Python with UV](../README.md#method-3-running-python-with-uv)
54+
so your environment variables and client configuration match the guidance in the
55+
main installation instructions. This ensures your manual testing matches the
56+
code under review.
57+
3658
## 📁 Structure
3759

3860
```

0 commit comments

Comments
 (0)