mirror of
https://github.com/jmagar/unraid-mcp.git
synced 2026-03-23 12:39:24 -07:00
docs: update credential setup docs to reflect elicitation flow
This commit is contained in:
12
CLAUDE.md
12
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
|
||||
|
||||
17
README.md
17
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
|
||||
|
||||
Reference in New Issue
Block a user