Skip to content

Commit 06ca413

Browse files
committed
docs: mcp add
1 parent 5b1e9a8 commit 06ca413

4 files changed

Lines changed: 140 additions & 234 deletions

File tree

IMPROVEMENTS.md

Lines changed: 0 additions & 226 deletions
This file was deleted.

README.md

Lines changed: 42 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,9 @@ One server for the whole team — one deployment, everyone connects via HTTP.
143143
- Copy the token (it won't be shown again!)
144144
- Store it somewhere safe
145145

146-
3. Add to Claude Desktop config (**Settings → Developer → Edit Config**):
146+
3. Configure your Claude client:
147+
148+
**Claude Desktop** (**Settings → Developer → Edit Config**):
147149

148150
```json
149151
{
@@ -161,7 +163,23 @@ One server for the whole team — one deployment, everyone connects via HTTP.
161163
}
162164
```
163165

164-
4. Restart Claude Desktop and test:
166+
**Claude Code** (terminal / IDE extensions):
167+
168+
```bash
169+
# macOS / Linux
170+
claude mcp add -s user testops ~/Downloads/testops-mcp-macos-arm64 \
171+
-e ALLURE_BASE_URL=https://your-testops.com \
172+
-e ALLURE_TOKEN=your-token-here
173+
174+
# Windows (PowerShell)
175+
claude mcp add -s user testops "$env:USERPROFILE\Downloads\testops-mcp-windows-amd64.exe" `
176+
-e ALLURE_BASE_URL=https://your-testops.com `
177+
-e ALLURE_TOKEN=your-token-here
178+
```
179+
180+
The `-s user` flag saves the config to `~/.claude.json` so it's available in all your projects. Use `-s local` to limit it to the current project only.
181+
182+
4. Restart Claude Desktop (or reload Claude Code) and test:
165183
```
166184
"List all projects in Allure"
167185
```
@@ -216,9 +234,11 @@ Server runs on `http://localhost:3000`
216234

217235
**3. Team members connect with their own tokens**
218236

219-
Each team member adds to their Claude Desktop config (**Settings → Developer → Edit Config**):
237+
Each team member picks their client:
220238

221-
**Windows:**
239+
**Claude Desktop** (**Settings → Developer → Edit Config**):
240+
241+
*Windows:*
222242
```json
223243
{
224244
"mcpServers": {
@@ -235,7 +255,7 @@ Each team member adds to their Claude Desktop config (**Settings → Developer
235255
}
236256
```
237257

238-
**macOS / Linux:**
258+
*macOS / Linux:*
239259
```json
240260
{
241261
"mcpServers": {
@@ -252,13 +272,27 @@ Each team member adds to their Claude Desktop config (**Settings → Developer
252272
}
253273
```
254274

255-
- **`Authorization`** — each user's named bearer token from `MCP_AUTH_TOKENS`. Omit the arg entirely if no auth is configured.
275+
**Claude Code** (terminal / IDE extensions — one command, all platforms):
276+
277+
```bash
278+
claude mcp add -s user --transport http testops http://your-server.com:3000/mcp \
279+
--header "Authorization:Bearer your-mcp-auth-token" \
280+
--header "X-Allure-Token:your-personal-allure-token"
281+
```
282+
283+
Verify it's registered:
284+
285+
```bash
286+
claude mcp list
287+
```
288+
289+
- **`Authorization`** — each user's named bearer token from `MCP_AUTH_TOKENS`. Omit the `--header "Authorization:..."` arg if the server has no auth configured.
256290
- **`X-Allure-Token`** — each person's own Allure API token. Actions in Allure are performed under that account.
257291

258292
Each person needs to:
259293
1. Get their personal Allure API token (Settings → API tokens in Allure TestOps)
260-
2. Add it to their Claude Desktop config as `X-Allure-Token`
261-
3. Restart Claude Desktop
294+
2. Add it to their config as `X-Allure-Token`
295+
3. Restart Claude Desktop (or reload Claude Code)
262296

263297
All actions will be done from their personal Allure account! ✅
264298

docs/INSTALLATION.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,55 @@ Edit your Claude Desktop config:
103103

104104
Restart Claude Desktop. The Allure tools should now appear in the tool dropdown.
105105

106+
### Step 6 (Alternative): Configure Claude Code CLI
107+
108+
If you use **Claude Code** in the terminal or IDE extensions instead of Claude Desktop, register the server with `claude mcp add`:
109+
110+
**Stdio mode** — runs the binary directly (no HTTP server needed):
111+
112+
```bash
113+
# macOS / Linux
114+
claude mcp add -s user testops ./bin/server \
115+
-e ALLURE_BASE_URL=https://your-allure.com \
116+
-e ALLURE_TOKEN=your_token_here
117+
118+
# Windows (PowerShell)
119+
claude mcp add -s user testops .\bin\server.exe `
120+
-e ALLURE_BASE_URL=https://your-allure.com `
121+
-e ALLURE_TOKEN=your_token_here
122+
```
123+
124+
**HTTP mode** — connect to a running server (`make run-http` or Docker):
125+
126+
```bash
127+
claude mcp add -s user --transport http testops http://localhost:3000/mcp \
128+
--header "Authorization:Bearer your-mcp-auth-token" \
129+
--header "X-Allure-Token:your-personal-allure-token"
130+
```
131+
132+
**Scope flags explained:**
133+
134+
| Flag | Where it's saved | Shared with team? |
135+
|------|-----------------|-------------------|
136+
| `-s user` | `~/.claude.json` | No |
137+
| `-s local` | `.claude/settings.local.json` | No (gitignored) |
138+
| `-s project` | `.mcp.json` in repo root | Yes (committed) |
139+
140+
Use `-s user` for personal setups. Use `-s project` to share the config via git (don't commit secrets — use `-e` env vars or a `.env` file).
141+
142+
Verify registration:
143+
144+
```bash
145+
claude mcp list
146+
# testops: /path/to/server.exe [user]
147+
```
148+
149+
Remove if needed:
150+
151+
```bash
152+
claude mcp remove testops
153+
```
154+
106155
---
107156

108157
## Docker Setup

0 commit comments

Comments
 (0)