Skip to content

Commit 15d7670

Browse files
committed
docs: add Quick Start for beginners in README
1 parent 5fa8cff commit 15d7670

1 file changed

Lines changed: 61 additions & 0 deletions

File tree

README.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,67 @@ Claude: The auth endpoint returned 401.
5858

5959
---
6060

61+
## 🎯 Quick Start (For Total Beginners)
62+
63+
### In 5 minutes:
64+
65+
1. **Download** the binary for your OS from [Releases](https://github.com/MimoJanra/TestOpsMCP/releases/latest)
66+
- Windows? Get `testops-mcp-windows-amd64.exe`
67+
- Mac? Get `testops-mcp-macos-arm64` (if Apple Silicon) or `testops-mcp-macos-amd64` (Intel)
68+
- Linux? Get `testops-mcp-linux-amd64`
69+
70+
2. **Get your Allure TestOps API token:**
71+
- Log into your Allure TestOps instance
72+
- Look for Settings → API tokens (or click your profile)
73+
- Create or copy a token
74+
- Save it somewhere safe (you'll need it next)
75+
76+
3. **Add to Claude Desktop:**
77+
- Open Claude Desktop
78+
- Click **Settings (bottom left)**
79+
- Click **Developer** tab
80+
- Click **Edit Config** (or **Edit Configuration**)
81+
- Find the `mcpServers` section (or create it if missing)
82+
- Copy-paste this (update the paths and token):
83+
84+
```json
85+
"mcpServers": {
86+
"testops": {
87+
"command": "/path/to/testops-mcp-binary",
88+
"env": {
89+
"ALLURE_BASE_URL": "https://your-testops-url.com",
90+
"ALLURE_TOKEN": "your-token-from-step-2"
91+
}
92+
}
93+
}
94+
```
95+
96+
**Windows example:**
97+
```json
98+
"mcpServers": {
99+
"testops": {
100+
"command": "C:\\Users\\Alice\\Downloads\\testops-mcp-windows-amd64.exe",
101+
"env": {
102+
"ALLURE_BASE_URL": "https://testops.company.com",
103+
"ALLURE_TOKEN": "abc123defg456"
104+
}
105+
}
106+
}
107+
```
108+
109+
4. **Restart Claude Desktop** (close and reopen)
110+
111+
5. **Try it!** In Claude, ask:
112+
```
113+
"List all projects in Allure"
114+
```
115+
116+
You should see your TestOps projects!
117+
118+
**Got stuck?** See detailed guides below. Problems? Open an [issue](https://github.com/MimoJanra/TestOpsMCP/issues).
119+
120+
---
121+
61122
## 🚀 Setup Options
62123

63124
### **Option A: Per-User (Recommended for Teams)**

0 commit comments

Comments
 (0)