Skip to content

Commit d05e978

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

File tree

1 file changed

+50
-22
lines changed

1 file changed

+50
-22
lines changed

README.md

Lines changed: 50 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,9 @@ go install github.com/jasonmadigan/kuadrant-mcp-server@latest
4242
```
4343

4444
### Using Docker
45+
46+
The server is available as a Docker image from GitHub Container Registry:
47+
4548
```bash
4649
docker pull ghcr.io/jasonmadigan/kuadrant-mcp-server:latest
4750
```
@@ -82,7 +85,9 @@ kuadrant-mcp-server -transport http -addr :8080
8285

8386
### With Docker
8487

85-
#### stdio transport
88+
Using the pre-built image from GitHub Container Registry:
89+
90+
#### stdio transport (default)
8691
```bash
8792
docker run -i --rm ghcr.io/jasonmadigan/kuadrant-mcp-server:latest
8893
```
@@ -105,17 +110,30 @@ docker-compose up
105110
### MCP Client Configuration
106111

107112
#### For stdio transport (Claude Desktop, CLI tools)
113+
114+
Using the pre-built Docker image:
108115
```json
109116
{
110117
"mcpServers": {
111-
"kuadrant-mcp": {
118+
"kuadrant": {
112119
"command": "docker",
113120
"args": ["run", "-i", "--rm", "ghcr.io/jasonmadigan/kuadrant-mcp-server:latest"]
114121
}
115122
}
116123
}
117124
```
118125

126+
Or if running the binary directly:
127+
```json
128+
{
129+
"mcpServers": {
130+
"kuadrant": {
131+
"command": "/path/to/kuadrant-mcp-server"
132+
}
133+
}
134+
}
135+
```
136+
119137
#### For HTTP transports (web applications)
120138
```json
121139
{
@@ -370,6 +388,23 @@ The Kubernetes MCP server will:
370388

371389
Edit `~/Library/Application Support/Claude/claude_desktop_config.json`:
372390

391+
Using Docker (recommended):
392+
```json
393+
{
394+
"mcpServers": {
395+
"kuadrant": {
396+
"command": "docker",
397+
"args": ["run", "-i", "--rm", "ghcr.io/jasonmadigan/kuadrant-mcp-server:latest"]
398+
},
399+
"kubernetes": {
400+
"command": "npx",
401+
"args": ["mcp-server-kubernetes"]
402+
}
403+
}
404+
}
405+
```
406+
407+
Or using the binary directly:
373408
```json
374409
{
375410
"mcpServers": {
@@ -547,32 +582,25 @@ cd kuadrant-mcp-server
547582
go build -o kuadrant-mcp-server
548583
```
549584

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

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

558-
### Run with Docker
588+
To use this server with Claude Code CLI:
559589

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

562592
```bash
563-
docker run -i kuadrant-mcp-server:latest
564-
```
593+
# Add using Docker image
594+
claude mcp add kuadrant docker run -i --rm ghcr.io/jasonmadigan/kuadrant-mcp-server:latest -s user
565595
566-
### Use with docker-compose
596+
# Verify installation
597+
claude mcp list
567598
568-
```bash
569-
docker-compose build
570-
docker-compose run --rm kuadrant-mcp
599+
# Start using
600+
claude # Start new session, type /mcp to see available servers
571601
```
572602

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

577605
1. **Build the server**
578606
```bash
@@ -754,19 +782,19 @@ rates:
754782

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

785+
Using the pre-built Docker image:
757786
```json
758787
{
759788
"mcpServers": {
760789
"kuadrant": {
761790
"command": "docker",
762-
"args": ["run", "-i", "kuadrant-mcp-server:latest"]
791+
"args": ["run", "-i", "--rm", "ghcr.io/jasonmadigan/kuadrant-mcp-server:latest"]
763792
}
764793
}
765794
}
766795
```
767796

768-
Or if running locally:
769-
797+
Or if running the binary locally:
770798
```json
771799
{
772800
"mcpServers": {

0 commit comments

Comments
 (0)