From f0a97edbf7e928f09fe1e4e74aafe9b3eb0a85bc Mon Sep 17 00:00:00 2001 From: Jacob Magar Date: Sat, 14 Mar 2026 04:29:35 -0400 Subject: [PATCH] docs: update credential setup docs to reflect elicitation flow --- CLAUDE.md | 12 ++++++++++++ README.md | 17 +++++++++++++++++ 2 files changed, 29 insertions(+) diff --git a/CLAUDE.md b/CLAUDE.md index 4bbeaf5..c991f14 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -182,6 +182,18 @@ When bumping the version, **always update both files** — they must stay in syn - `pyproject.toml` → `version = "X.Y.Z"` under `[project]` - `.claude-plugin/plugin.json` → `"version": "X.Y.Z"` +### Plugin Cache `.env` (automatic via elicitation) +On first tool call without credentials, the server triggers MCP elicitation to +collect `UNRAID_API_URL` and `UNRAID_API_KEY` interactively, then writes `.env` +to the plugin cache dir automatically. No manual symlinking needed. + +Manual fallback (if client doesn't support elicitation): +```bash +VERSION=$(grep '^version' pyproject.toml | grep -oP '[\d.]+') && \ +ln -sf /home/jmagar/workspace/unraid-mcp/.env \ + ~/.claude/plugins/cache/jmagar-unraid-mcp/unraid/${VERSION}/.env +``` + ### Symlinks `AGENTS.md` and `GEMINI.md` are symlinks to `CLAUDE.md` for Codex/Gemini compatibility: ```bash diff --git a/README.md b/README.md index 10c3fc6..ee09466 100644 --- a/README.md +++ b/README.md @@ -54,6 +54,23 @@ This provides instant access to Unraid monitoring and management through Claude **See [.claude-plugin/README.md](.claude-plugin/README.md) for detailed plugin documentation.** +### ⚙️ Credential Setup (Automatic) + +On first use, the plugin will **automatically prompt you for credentials** via an +interactive elicitation dialog in Claude Code. Simply call any Unraid tool and +follow the prompts — no manual `.env` configuration needed. + +Alternatively, trigger setup explicitly: +``` +unraid_health action=setup +``` + +Credentials are saved to `.env` in the plugin cache directory and persisted +across restarts. + +> **Manual fallback:** If elicitation is not supported by your client, create +> `.env` in the plugin cache directory manually (see `.env.example` for the format). + --- ## 🚀 Quick Start