@@ -58,100 +58,87 @@ Claude: The auth endpoint returned 401.
5858
5959---
6060
61- ## 🚀 Get Started in 2 Minutes
61+ ## 🚀 Get Started in 3 Steps
6262
63- ### 1️⃣ Download Pre-Built Binary
63+ ### 1️⃣ Download Binary for Your Platform
6464
65- Works on ** Windows ** , ** macOS ** (Intel & Apple Silicon), and ** Linux ** .
65+ [ ** 👉 Get Latest Release ** ] ( https://github.com/MimoJanra/TestOpsMCP/releases/latest )
6666
67- [ ** 👉 Download Latest Release →** ] ( https://github.com/MimoJanra/TestOpsMCP/releases/latest )
67+ - ** Windows** : ` testops-mcp-windows-amd64.exe `
68+ - ** macOS Intel** : ` testops-mcp-macos-amd64 `
69+ - ** macOS Apple Silicon** : ` testops-mcp-macos-arm64 `
70+ - ** Linux** : ` testops-mcp-linux-amd64 `
6871
69- ### 2️⃣ Set Your Credentials
72+ ### 2️⃣ Add to Claude Desktop Config
7073
71- ``` bash
72- export ALLURE_BASE_URL=" https://your-testops-instance.com"
73- export ALLURE_TOKEN=" your-api-token"
74- ```
75-
76- [ How to get your Allure API token →] ( https://docs.qameta.io/allure-testops/advanced/api/ )
77-
78- ### 3️⃣ Run It
79-
80- ``` bash
81- # macOS/Linux
82- ./testops-mcp-macos-amd64 --http
83-
84- # Windows
85- testops-mcp-windows-amd64.exe --http
86-
87- # Linux
88- ./testops-mcp-linux-amd64 --http
89- ```
74+ Open ** Settings → Developer → Edit Config** in Claude Desktop.
9075
91- Server starts on ` http://localhost:3000 ` ✓
92-
93- ### 4️⃣ Connect Claude
94-
95- ** Claude Desktop:** Add to ` claude_desktop_config.json `
76+ Add this to the ` mcpServers ` section:
9677
9778``` json
9879{
9980 "mcpServers" : {
10081 "allure" : {
101- "url" : " http://localhost:3000"
82+ "command" : " C:\\ Users\\ YourName\\ Downloads\\ testops-mcp-windows-amd64.exe" ,
83+ "env" : {
84+ "ALLURE_BASE_URL" : " https://your-testops-instance.com" ,
85+ "ALLURE_TOKEN" : " your-api-token" ,
86+ "REQUEST_TIMEOUT" : " 30" ,
87+ "LOG_LEVEL" : " INFO"
88+ }
10289 }
10390 }
10491}
10592```
10693
107- Restart Claude → TestOps tools appear in the dropdown ✓
94+ ** Replace:**
95+ - ` C:\\Users\\YourName\\Downloads\\testops-mcp-windows-amd64.exe ` → path to your binary
96+ - ` https://your-testops-instance.com ` → your Allure TestOps URL
97+ - ` your-api-token ` → your Allure API token ([ how to get it →] ( https://docs.qameta.io/allure-testops/advanced/api/ ) )
98+
99+ ### 3️⃣ Restart Claude
100+
101+ Close and reopen Claude Desktop. TestOps tools now appear in the tool dropdown! ✅
102+
103+ ** That's it.** You're ready to use it.
108104
109105---
110106
111- ## Build from Source
107+ ## 📌 Need HTTP Mode? (for teams)
112108
113- ### 1. Clone & Build
109+ If you want to run a shared server for your team instead of local Claude Desktop:
114110
115111``` bash
116- git clone https://github.com/MimoJanra/TestOpsMCP.git
117- cd TestOpsMCP
118- make build
119- ```
112+ # macOS/Linux
113+ ./testops-mcp-macos-amd64 --http
120114
121- ### 2. Configure
115+ # Windows
116+ testops-mcp-windows-amd64.exe --http
122117
123- ``` bash
124- cp .env.example .env
125- # Edit .env with your Allure credentials
118+ # Linux
119+ ./testops-mcp-linux-amd64 --http
126120```
127121
128- ### 3. Run
122+ Server starts on ` http://localhost:3000 ` → [ Full team setup guide → ] ( #-team-deployment-http-mode )
129123
130- ``` bash
131- make run # Local development
132- # or
133- make run-http # Team/server mode
134- ```
124+ ---
135125
136- ### 4. Connect Claude Desktop
126+ ## 🔧 Build from Source (Optional)
137127
138- Edit your Claude config (Windows: ` %APPDATA%\Claude\claude_desktop_config.json ` ) :
128+ If you prefer to build the binary yourself :
139129
140- ``` json
141- {
142- "mcpServers" : {
143- "allure" : {
144- "command" : " C:\\ Users\\ YourName\\ TestOpsMCP\\ bin\\ server.exe" ,
145- "env" : {
146- "ALLURE_BASE_URL" : " https://your-allure.com" ,
147- "ALLURE_TOKEN" : " your_token"
148- }
149- }
150- }
151- }
130+ ``` bash
131+ # Clone
132+ git clone https://github.com/MimoJanra/TestOpsMCP.git
133+ cd TestOpsMCP
134+
135+ # Build
136+ make build
137+
138+ # Binary created at: ./bin/server.exe (Windows)
152139```
153140
154- Restart Claude Desktop — Allure tools appear in the dropdown .
141+ Then follow ** Step 2 ** above to add it to Claude Desktop config .
155142
156143---
157144
@@ -251,93 +238,19 @@ Restart Claude Desktop — Allure tools appear in the dropdown.
251238
252239---
253240
254- ## Requirements
255-
256- - ** Go 1.22+** — [ Download] ( https://golang.org/dl/ )
257- - ** Allure TestOps** — Instance with API access
258- - ** Claude Desktop** or MCP-compatible client
259-
260- Optional:
261- - ** Docker** — For containerized deployment
262- - ** Docker Compose** — For team deployment
263-
264- ## Getting Started by Deployment Type
265-
266- ### 🖥️ Local Development (Claude Desktop)
267-
268- See [ Installation Guide] ( ./docs/INSTALLATION.md#local-development ) for step-by-step setup.
269-
270- ``` bash
271- make build && make run
272- ```
273-
274- ### 🐳 Docker (Single Instance)
275-
276- ``` bash
277- docker build -t allure-mcp .
278- docker run -e ALLURE_BASE_URL=https://your-allure.com \
279- -e ALLURE_TOKEN=your_token \
280- -p 3000:3000 \
281- allure-mcp --http
282- ```
283-
284- ### 🔄 Docker Compose (Team)
285-
286- ``` bash
287- cp .env.example .env
288- # Edit .env with your credentials
289- docker-compose up -d
290- ```
291-
292- ### ☁️ Production (Kubernetes, Systemd, etc.)
241+ ## ✅ Requirements
293242
294- See [ Deployment Guide] ( ./docs/DEPLOYMENT.md ) for:
295- - Nginx reverse proxy with HTTPS
296- - Kubernetes manifests with auto-scaling
297- - Systemd service files
298- - Monitoring & health checks
243+ ### For Local Claude Desktop (Easiest)
244+ - ✅ Claude Desktop (macOS, Windows, Linux)
245+ - ✅ Allure TestOps account with API access
246+ - ✅ Pre-built binary (no installation needed)
299247
300- ## Team Deployment (HTTP Mode)
301-
302- For shared server or team use, run in HTTP mode:
303-
304- ``` bash
305- docker-compose up -d
306- # Server listens on :3000
307- ```
308-
309- ** Team members connect via:**
310-
311- ``` json
312- {
313- "mcpServers" : {
314- "allure" : {
315- "url" : " http://your-server:3000" ,
316- "env" : {
317- "MCP_AUTH_TOKEN" : " your_shared_secret_from_team"
318- }
319- }
320- }
321- }
322- ```
323-
324- ** For production HTTPS:**
325-
326- Use Nginx reverse proxy (nginx config in [ Deployment Guide] ( ./docs/DEPLOYMENT.md#reverse-proxy-setup ) ):
327-
328- ``` bash
329- # With Caddy (automatic HTTPS)
330- caddy run # Reads from Caddyfile
331- ```
332-
333- Or use ngrok for quick HTTPS tunneling:
334-
335- ``` bash
336- ngrok http 3000
337- # Share https://your-unique-id.ngrok.io with your team
338- ```
248+ ### For Building from Source
249+ - Go 1.22+ — [ Download] ( https://golang.org/dl/ )
250+ - ` make ` — Usually pre-installed on macOS/Linux
339251
340- 📚 ** Full setup:** [ Deployment Guide] ( ./docs/DEPLOYMENT.md )
252+ ### For Team Deployment
253+ - Docker & Docker Compose — [ Download] ( https://www.docker.com/ )
341254
342255## Configuration
343256
0 commit comments