Skip to content

Commit c254b95

Browse files
vistaarjunejaHarness
authored andcommitted
feat: [ML-1079]: update README (#4)
* feat: [ML-1079]: update README
1 parent 437c6f2 commit c254b95

File tree

1 file changed

+49
-5
lines changed

1 file changed

+49
-5
lines changed

README.md

Lines changed: 49 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Toolset Name: `logs`
5858

5959
## Quickstart
6060

61-
### Build from source
61+
### Build from Source
6262

6363
1. Clone the repository:
6464
```bash
@@ -76,6 +76,19 @@ go build -o cmd/harness-mcp-server/harness-mcp-server ./cmd/harness-mcp-server
7676
HARNESS_API_KEY=your_api_key HARNESS_DEFAULT_ORG_ID=your_org_id HARNESS_DEFAULT_PROJECT_ID=your_project_id ./cmd/harness-mcp-server/harness-mcp-server stdio
7777
```
7878

79+
### Use Docker Image
80+
81+
Alternatively, you can use the pre-built Docker image:
82+
83+
```bash
84+
docker run -i --rm \
85+
-e HARNESS_API_KEY=your_api_key \
86+
-e HARNESS_DEFAULT_ORG_ID=your_org_id \
87+
-e HARNESS_DEFAULT_PROJECT_ID=your_project_id \
88+
-e HARNESS_BASE_URL=your_base_url \
89+
harness/mcp-server stdio
90+
```
91+
7992
### Claude Desktop Configuration
8093

8194
On MacOS: `~/Library/Application\ Support/Claude/claude_desktop_config.json`
@@ -113,6 +126,8 @@ To use the Harness MCP Server with Windsurf:
113126

114127
1. Add the server configuration to your Windsurf config file:
115128

129+
### Using Local Binary
130+
116131
```json
117132
{
118133
"mcpServers": {
@@ -130,6 +145,39 @@ To use the Harness MCP Server with Windsurf:
130145
}
131146
```
132147

148+
### Using Docker Image
149+
150+
```json
151+
{
152+
"mcpServers": {
153+
"harness": {
154+
"command": "docker",
155+
"args": [
156+
"run",
157+
"-i",
158+
"--rm",
159+
"-e",
160+
"HARNESS_API_KEY",
161+
"-e",
162+
"HARNESS_DEFAULT_ORG_ID",
163+
"-e",
164+
"HARNESS_DEFAULT_PROJECT_ID",
165+
"-e",
166+
"HARNESS_BASE_URL",
167+
"harness/mcp-server",
168+
"stdio"
169+
],
170+
"env": {
171+
"HARNESS_API_KEY": "<YOUR_API_KEY>",
172+
"HARNESS_DEFAULT_ORG_ID": "<YOUR_ORG_ID>",
173+
"HARNESS_DEFAULT_PROJECT_ID": "<YOUR_PROJECT_ID>",
174+
"HARNESS_BASE_URL": "<YOUR_BASE_URL>"
175+
}
176+
}
177+
}
178+
}
179+
```
180+
133181
## Development
134182

135183
### Command Line Arguments
@@ -172,7 +220,3 @@ npx @modelcontextprotocol/inspector /path/to/harness-mcp-server stdio
172220
```
173221

174222
Upon launching, the Inspector will display a URL that you can access in your browser to begin debugging.
175-
176-
## To do
177-
178-
Add Docker image for easier use

0 commit comments

Comments
 (0)