Skip to content

Commit 728a615

Browse files
authored
Update MCP deployment guide for HTTP transport (#853)
* Update MCP deployment guide for HTTP transport migration - Update architecture diagram from HTTP/SSE to HTTP - Update server transport from sse to streamable-http - Update Claude Code client config from transport:sse to type:http - Update Python client examples to use streamable_http_client - Update all /sse endpoints to /mcp - Update server configuration examples with new host/port API - Update curl testing commands This completes the documentation updates for the HTTP transport migration started in PR #852. * Update dashboard deployment guide for HTTP transport migration - Update all MCP server URLs from /sse to /mcp endpoint - Update environment variable examples - Update systemd service configuration examples - Update troubleshooting curl commands This ensures dashboard deployment documentation is consistent with the MCP server HTTP transport migration.
1 parent 45c0868 commit 728a615

2 files changed

Lines changed: 19 additions & 19 deletions

File tree

deployment/MCP_SERVER_DEPLOYMENT.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This guide explains how to deploy the Release Tests MCP server on your VM for re
55
## Architecture
66

77
```
8-
┌─────────────────┐ HTTP/SSE ┌─────────────────┐
8+
┌─────────────────┐ HTTP ┌─────────────────┐
99
│ Your Laptop │◄─────────────────────────►│ VM Server │
1010
│ - Claude Code │ http://vm-hostname:8000 │ - OAR CLI │
1111
│ - Other AI │ │ - Credentials │
@@ -71,7 +71,7 @@ python3 -m mcp.server
7171
You should see:
7272
```
7373
INFO - Starting Release Tests MCP Server
74-
INFO - Transport: SSE (HTTP)
74+
INFO - Transport: streamable-http
7575
INFO - Running on http://127.0.0.1:8000
7676
```
7777

@@ -81,10 +81,10 @@ Edit `mcp_server/server.py` and change the last line:
8181

8282
```python
8383
# Change from:
84-
mcp.run(transport="sse")
84+
mcp.run(transport="streamable-http")
8585

8686
# To (listen on all interfaces):
87-
mcp.run(transport="sse", sse_params={"host": "0.0.0.0", "port": 8080})
87+
mcp.run(transport="streamable-http", host="0.0.0.0", port=8080)
8888
```
8989

9090
### 5. Configure Firewall (If Needed)
@@ -190,8 +190,8 @@ Add to your Claude Code MCP settings:
190190
{
191191
"mcpServers": {
192192
"release-tests": {
193-
"transport": "sse",
194-
"url": "http://your-vm-hostname.redhat.com:8080/sse"
193+
"type": "http",
194+
"url": "http://your-vm-hostname.redhat.com:8080/mcp"
195195
}
196196
}
197197
}
@@ -203,11 +203,11 @@ Add to your Claude Code MCP settings:
203203

204204
```python
205205
from mcp import ClientSession
206-
from mcp.client.sse import sse_client
206+
from mcp.client.streamable_http import streamable_http_client
207207

208-
async with sse_client(
209-
url="http://your-vm-hostname.redhat.com:8080/sse"
210-
) as (read, write):
208+
async with streamable_http_client(
209+
url="http://your-vm-hostname.redhat.com:8080/mcp"
210+
) as (read, write, _):
211211
async with ClientSession(read, write) as session:
212212
# List available tools
213213
tools = await session.list_tools()
@@ -227,16 +227,16 @@ async with sse_client(
227227

228228
```bash
229229
# On the VM
230-
curl http://localhost:8080/sse
230+
curl http://localhost:8080/mcp
231231
```
232232

233-
Should return SSE stream or connection info.
233+
Should return MCP connection info or server metadata.
234234

235235
### 2. Test from Your Laptop (Remote)
236236

237237
```bash
238238
# On your laptop
239-
curl http://your-vm-hostname.redhat.com:8080/sse
239+
curl http://your-vm-hostname.redhat.com:8080/mcp
240240
```
241241

242242
Should also connect successfully.

deployment/RELEASE_PROGRESS_DASHBOARD_DEPLOYMENT.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This guide covers deploying the Release Progress Dashboard as a systemd service
1212
2. **Environment Variables** (in `~/.bash_profile` or `~/.bashrc`):
1313
```bash
1414
# Optional: MCP server URL (defaults to localhost:8000)
15-
export MCP_SERVER_URL="http://localhost:8000/sse" # Or remote MCP server URL
15+
export MCP_SERVER_URL="http://localhost:8000/mcp" # Or remote MCP server URL
1616
```
1717

1818
3. **Dependencies**:
@@ -25,7 +25,7 @@ This guide covers deploying the Release Progress Dashboard as a systemd service
2525
4. **MCP Server**:
2626
- The dashboard requires the MCP server to be running
2727
- See `MCP_SERVER_DEPLOYMENT.md` for MCP server deployment
28-
- Default MCP server URL: `http://localhost:8000/sse`
28+
- Default MCP server URL: `http://localhost:8000/mcp`
2929

3030
## Installation Steps
3131

@@ -55,7 +55,7 @@ WorkingDirectory=/home/your-username/release-tests
5555
ExecStart=/bin/bash -l -c 'cd /home/your-username/release-tests && ...'
5656

5757
# Optional: Customize MCP server URL if using remote server
58-
Environment="MCP_SERVER_URL=http://your-mcp-server:8000/sse"
58+
Environment="MCP_SERVER_URL=http://your-mcp-server:8000/mcp"
5959

6060
# Optional: Change dashboard port (default: 8501)
6161
Environment="STREAMLIT_SERVER_PORT=8501"
@@ -164,7 +164,7 @@ The service can optionally use environment variables from the user's `.bash_prof
164164
# ~/.bash_profile or ~/.bashrc
165165

166166
# MCP server URL (optional, defaults to localhost:8000)
167-
export MCP_SERVER_URL="http://localhost:8000/sse"
167+
export MCP_SERVER_URL="http://localhost:8000/mcp"
168168
```
169169

170170
After modifying environment variables, restart the service:
@@ -227,13 +227,13 @@ sudo journalctl -u release-progress-dashboard.service -n 50
227227
sudo systemctl status release-tests-mcp.service
228228

229229
# Test MCP server endpoint
230-
curl http://localhost:8000/sse
230+
curl http://localhost:8000/mcp
231231
```
232232

233233
**Check network connectivity**:
234234
```bash
235235
# If using remote MCP server
236-
curl http://your-mcp-server:8000/sse
236+
curl http://your-mcp-server:8000/mcp
237237
```
238238

239239
**Review dashboard logs**:

0 commit comments

Comments
 (0)