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:
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