Skip to content

Commit 11d15d2

Browse files
committed
feat(site): close audit-table gaps + Patch76 review
Addresses Patch76's CHANGES_REQUESTED review on PR homeassistant-ai#1120 plus the audit-table walk-through showed several legit nuggets I'd skipped on the first pass. Adding all of them now. Patch76 #1 — Cloudflared HA-addon `additional_hosts` block: Added a <details> "Running on Home Assistant OS? Use the Cloudflared add-on" section to the existing Cloudflare Tunnel block, with the brenner-tobias add-on badge link and the `additional_hosts:` YAML pointing at port 9583. Patch76 #2 + #3 — github-copilot-agents org-deployment notes: New "Org & Repository Deployment" instruction-block (any transport) documenting: - Repository-wide config via Settings → Copilot → Coding agent → MCP configuration on github.com (applies to all users with repo access, alternative to per-user .vscode/mcp.json) - Operational prerequisite: the "MCP servers" policy must be enabled for the org/enterprise — admins disable it by default. JetBrains — extended clientNote with the "Import from Claude" button tip (Settings → Tools → AI Assistant → MCP Servers) for users migrating from Claude Desktop. Audit-table gaps closed: - Antigravity: new instruction-block with the UI nav steps to the raw config editor (... menu → MCP Servers → Manage MCP Servers → View raw config) plus an HTTP-transport caveat (gated to !isStdio) about "connection closed" / "SSE stream failed to reconnect" errors with a recommendation to switch to stdio. - Codex: extended Management Commands block with a Codex Desktop walkthrough (Settings → MCP → Add Server with field names) and an OAuth-2.0-for-remote-servers note (gated to !isStdio). - VS Code: secure-input-prompts block now also mentions the vscode:mcp/install?<config> deep-link install pattern. - Copilot CLI: Notes & extras section after both the stdio and HTTP step blocks — Server Type legend (1/2/3/4 for Local/STDIO/HTTP/SSE), KEY=VALUE env-var format, * vs comma-list Tools format, COPILOT_HOME override, /mcp interactive command, "GitHub MCP server included by default" reminder. - OpenCode: Management Commands block extended with OPENCODE_CONFIG env-var path override, project-vs-global config-merge precedence (with link to opencode.ai/docs), {env:VAR} headers interpolation pattern for Bearer auth, oauth: false opt-out flag, home-assistant_* tool namespacing, and a 92+-tools context-size warning recommending a dedicated OpenCode agent for HA-heavy workflows. - Webhook Proxy: "How It Works" section before the install steps with the routing chain (AI client → HTTPS → reverse proxy → HA :8123 → webhook /api/webhook/<id> → MCP add-on). Plus a comparison table vs Cloudflare Tunnel (setup/cost/routing/best-for) after the steps. - Continue: clientNote with the Agent-Mode-required gotcha — MCP only works when Continue is in Agent Mode (use the agent selector near the chat input). - Claude.ai: clientNote with the Pro/Max/Team/Enterprise subscription requirement and the "Search and tools" button tip for per-conversation tool toggling. - Claude Code: clientNote noting config changes take effect immediately (no restart needed) — useful contrast with the restart-required clients. - Linux quick-test: new FAQ item ("Test ha-mcp without configuring a client") with the public-demo-server one-liner from the deleted linux.md body. TOC entry added. - AGENTS.md: appended a sentence to the "adding a new entry" recipe noting that arrays should be kept ordered by `order` (the wizard renders in array order without re-sorting). Intentional skips (with reason, in case anyone re-audits): - JetBrains Node 18+ requirement: only relevant for npm-based MCP servers; ha-mcp uses uvx, so this is a non-applicable constraint. - JetBrains 2025.2+ built-in MCP server: about the IDE itself acting as an MCP server, not relevant to ha-mcp client setup. - Zed Bearer-header HTTP shape: Zed is in stdioOnlyClients, so the wizard routes Zed users through mcp-proxy for HTTP — the isZed HTTP branch in the JSON builder is dead code for ha-mcp users going through the wizard. Adding a Bearer-auth alternative would contradict the httpNote. - uvx Python 3.10+ claim: source body was wrong (faq says 3.13+, matches pyproject.toml requires-python = "==3.13.*"). Body deletion auto-resolved. Build verified clean (npm run build, 7 pages, 18.4s).
1 parent 04c3ca6 commit 11d15d2

3 files changed

Lines changed: 106 additions & 4 deletions

File tree

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -458,7 +458,7 @@ These feed the picker tiles in the markup section AND the wizard `<script>` bloc
458458

459459
**Adding a new client / platform / connection / deployment:**
460460

461-
1. Add an entry to the appropriate inline array (insert at the right `order` position).
461+
1. Add an entry to the appropriate inline array (insert at the right `order` position). Keep each array ordered by the `order` field — the wizard renders entries in array order without re-sorting.
462462
2. Add a wizard branch in the `<script>` block keyed off the new entry's `id`. Match neighboring patterns: JSON clients add an `else if` in the JSON config builder; CLI clients add a CLI command emit; UI clients add an `instruction-block` div with click steps. See `cursor` / `chatgpt` / `claude-code` / `cloudflared` for examples.
463463
3. If the addition has cross-cutting troubleshooting content (PATH issues, restart requirements, version requirements), add it to `faq.astro`.
464464

site/src/pages/faq.astro

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ const withBase = (path: string) => {
3131
<li class="ml-4"><a href="#webhook-proxy" class="text-blue-400 hover:underline">Webhook Proxy Alternative</a></li>
3232
<li class="ml-4"><a href="#antigravity-troubleshooting" class="text-blue-400 hover:underline">Antigravity Client Troubleshooting</a></li>
3333
<li class="ml-4"><a href="#claude-ai-connection" class="text-blue-400 hover:underline">Claude.ai Connection Issues</a></li>
34+
<li class="ml-4"><a href="#quick-test" class="text-blue-400 hover:underline">Test ha-mcp Without Configuring a Client</a></li>
3435
<li class="ml-4"><a href="#uvx-background" class="text-blue-400 hover:underline">Keep ha-mcp-web Running in the Background</a></li>
3536
<li class="ml-4"><a href="#docker-port" class="text-blue-400 hover:underline">Docker: Changing the Port</a></li>
3637
<li><a href="#custom-component" class="text-blue-400 hover:underline">Custom Component (ha_mcp_tools)</a></li>
@@ -309,6 +310,13 @@ source ~/.zshrc
309310
</ol>
310311
</div>
311312

313+
<div class="faq-item" id="quick-test">
314+
<h3 class="text-lg font-medium text-white mb-2">Test ha-mcp without configuring a client</h3>
315+
<p class="text-slate-300 mb-3">Before setting up a client, you can run a quick smoke test against the public demo server to confirm <code class="bg-slate-800 px-1 rounded">uvx</code> is installed and ha-mcp launches correctly:</p>
316+
<pre class="code-block"><code>HOMEASSISTANT_URL=https://ha-mcp-demo-server.qc-h.net HOMEASSISTANT_TOKEN=demo uvx ha-mcp@latest</code></pre>
317+
<p class="text-slate-400 text-sm mt-3">This starts ha-mcp in stdio mode connected to the public demo Home Assistant instance. Press <strong>Ctrl+C</strong> to stop. If it launches without errors, your environment is ready — replace the URL and token with your own values to connect to your Home Assistant.</p>
318+
</div>
319+
312320
<div class="faq-item" id="uvx-background">
313321
<h3 class="text-lg font-medium text-white mb-2">Keep ha-mcp-web running in the background</h3>
314322
<p class="text-slate-300 mb-3">To run the ha-mcp HTTP server detached from the terminal so it survives logout:</p>

0 commit comments

Comments
 (0)