Skip to content

Commit b454843

Browse files
Rick Valdesclaude
andcommitted
Clarify the two credentials, and that the SIEM connection is configurable in-chat
The First-run section conflated two different systems on adjacent lines. It now has a table that separates them: the ThreatWinds API key authenticates the LLM (set via /connect), and the UTMStack connection reaches your SIEM (URL + API key or username/password). Documents that the UTMStack connection can be set either with utmstack-mcp init or by simply asking the assistant, which now has configure_server/remove_server tools — so both credentials are reachable from the CLI. Notes that the in-chat path deliberately cannot enable remote command execution. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 420193d commit b454843

1 file changed

Lines changed: 21 additions & 4 deletions

File tree

README.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -86,14 +86,31 @@ and the installers verify against it and refuse to install if they cannot.
8686

8787
## First run
8888

89+
You configure **two independent things**, and it's worth keeping them straight:
90+
91+
| | What it's for | How to set it |
92+
|---|---|---|
93+
| **ThreatWinds API key** | the **LLM** that powers the assistant | `utmstack``/connect` (or `utmstack providers login`) |
94+
| **UTMStack connection** | your **SIEM** — the URL + API key or username/password | `utmstack-mcp init`, **or just ask the assistant** |
95+
96+
These are different systems with different credentials. The ThreatWinds key authenticates
97+
the model; the UTMStack connection is how the assistant reaches your SIEM's alerts, logs,
98+
and agents.
99+
89100
```bash
90-
utmstack-mcp init # connect your UTMStack server (URL + credentials)
91101
utmstack # start the CLI, then /connect to paste your ThreatWinds API key
92102
```
93103

94-
`utmstack-mcp init` validates your credentials against the live API before
95-
saving them, and writes them to a `0600` file outside any CLI config — so no
96-
credentials end up in shell history or in a config file you might share.
104+
**Connecting your UTMStack — two ways:**
105+
106+
- Run the wizard: `utmstack-mcp init` prompts for the URL and credentials, validates them
107+
against the live API, and stores them in a `0600` file.
108+
- Or just tell the assistant: *"connect to my UTMStack at https://utm.example.com with API
109+
key …"* or *"change my UTMStack URL to …"*. It configures the connection for you and the
110+
change takes effect immediately — no restart. (It deliberately can't enable remote
111+
command execution that way; that stays a `utmstack-mcp init` / config-file decision.)
112+
113+
Either path keeps credentials out of shell history and out of any file you might share.
97114

98115
## What ships out of the box
99116

0 commit comments

Comments
 (0)