Skip to content

Commit 1785751

Browse files
committed
container image notes
Signed-off-by: Jason Madigan <jason@jasonmadigan.com>
1 parent 3454276 commit 1785751

File tree

1 file changed

+55
-33
lines changed

1 file changed

+55
-33
lines changed

README.md

Lines changed: 55 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,13 @@ A Model Context Protocol (MCP) server that generates Kuadrant policy manifests i
99
## Quick Start (Claude Code CLI)
1010

1111
```bash
12-
# Clone and build
13-
git clone https://github.com/jasonmadigan/kuadrant-mcp-server
14-
cd kuadrant-mcp-server
15-
go build -o kuadrant-mcp-server
16-
17-
# Add to Claude Code (project-scoped)
18-
claude mcp add kuadrant ./kuadrant-mcp-server
12+
# Add the MCP server using Docker (available in all projects)
13+
claude mcp add kuadrant docker run -i --rm ghcr.io/jasonmadigan/kuadrant-mcp-server:latest -s user
1914

20-
# Or add for your user (available in all projects)
21-
claude mcp add kuadrant $(pwd)/kuadrant-mcp-server -s user
22-
23-
# Verify and use
15+
# Verify installation
2416
claude mcp list
17+
18+
# Start using
2519
claude # Start new session, type /mcp to see available servers
2620
```
2721

@@ -42,6 +36,9 @@ go install github.com/jasonmadigan/kuadrant-mcp-server@latest
4236
```
4337

4438
### Using Docker
39+
40+
The server is available as a Docker image from GitHub Container Registry:
41+
4542
```bash
4643
docker pull ghcr.io/jasonmadigan/kuadrant-mcp-server:latest
4744
```
@@ -82,7 +79,9 @@ kuadrant-mcp-server -transport http -addr :8080
8279

8380
### With Docker
8481

85-
#### stdio transport
82+
Using the pre-built image from GitHub Container Registry:
83+
84+
#### stdio transport (default)
8685
```bash
8786
docker run -i --rm ghcr.io/jasonmadigan/kuadrant-mcp-server:latest
8887
```
@@ -105,17 +104,30 @@ docker-compose up
105104
### MCP Client Configuration
106105

107106
#### For stdio transport (Claude Desktop, CLI tools)
107+
108+
Using the pre-built Docker image:
108109
```json
109110
{
110111
"mcpServers": {
111-
"kuadrant-mcp": {
112+
"kuadrant": {
112113
"command": "docker",
113114
"args": ["run", "-i", "--rm", "ghcr.io/jasonmadigan/kuadrant-mcp-server:latest"]
114115
}
115116
}
116117
}
117118
```
118119

120+
Or if running the binary directly:
121+
```json
122+
{
123+
"mcpServers": {
124+
"kuadrant": {
125+
"command": "/path/to/kuadrant-mcp-server"
126+
}
127+
}
128+
}
129+
```
130+
119131
#### For HTTP transports (web applications)
120132
```json
121133
{
@@ -370,6 +382,23 @@ The Kubernetes MCP server will:
370382

371383
Edit `~/Library/Application Support/Claude/claude_desktop_config.json`:
372384

385+
Using Docker (recommended):
386+
```json
387+
{
388+
"mcpServers": {
389+
"kuadrant": {
390+
"command": "docker",
391+
"args": ["run", "-i", "--rm", "ghcr.io/jasonmadigan/kuadrant-mcp-server:latest"]
392+
},
393+
"kubernetes": {
394+
"command": "npx",
395+
"args": ["mcp-server-kubernetes"]
396+
}
397+
}
398+
}
399+
```
400+
401+
Or using the binary directly:
373402
```json
374403
{
375404
"mcpServers": {
@@ -547,32 +576,25 @@ cd kuadrant-mcp-server
547576
go build -o kuadrant-mcp-server
548577
```
549578

550-
## Docker Usage
551-
552-
### Build the Docker image
553579

554-
```bash
555-
docker build -t kuadrant-mcp-server:latest .
556-
```
580+
## Claude Code CLI Setup
557581

558-
### Run with Docker
582+
To use this server with Claude Code CLI:
559583

560-
Since MCP servers communicate via stdio, run interactively:
584+
### Option 1: Using Docker (Recommended)
561585

562586
```bash
563-
docker run -i kuadrant-mcp-server:latest
564-
```
587+
# Add using Docker image
588+
claude mcp add kuadrant docker run -i --rm ghcr.io/jasonmadigan/kuadrant-mcp-server:latest -s user
565589
566-
### Use with docker-compose
590+
# Verify installation
591+
claude mcp list
567592
568-
```bash
569-
docker-compose build
570-
docker-compose run --rm kuadrant-mcp
593+
# Start using
594+
claude # Start new session, type /mcp to see available servers
571595
```
572596

573-
## Claude Code CLI Setup
574-
575-
To use this server with Claude Code CLI:
597+
### Option 2: Using Local Binary
576598

577599
1. **Build the server**
578600
```bash
@@ -754,19 +776,19 @@ rates:
754776

755777
To use this server with an MCP client (like Claude Desktop), add it to your MCP configuration:
756778

779+
Using the pre-built Docker image:
757780
```json
758781
{
759782
"mcpServers": {
760783
"kuadrant": {
761784
"command": "docker",
762-
"args": ["run", "-i", "kuadrant-mcp-server:latest"]
785+
"args": ["run", "-i", "--rm", "ghcr.io/jasonmadigan/kuadrant-mcp-server:latest"]
763786
}
764787
}
765788
}
766789
```
767790

768-
Or if running locally:
769-
791+
Or if running the binary locally:
770792
```json
771793
{
772794
"mcpServers": {

0 commit comments

Comments
 (0)