Skip to content

Commit 6f36706

Browse files
authored
prepare documentation 0 3 0 (#325)
* uvenv -> uvx, add mcpgateway.translate and fast-time-server docs Signed-off-by: Mihai Criveti <[email protected]> * autoflake isort black Signed-off-by: Mihai Criveti <[email protected]> --------- Signed-off-by: Mihai Criveti <[email protected]>
1 parent 5863f46 commit 6f36706

25 files changed

+1207
-180
lines changed

.env.example

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,7 @@ UNHEALTHY_THRESHOLD=3
242242
# Lock file Settings
243243
#####################################
244244

245-
# This path is append with the system temp directory.
245+
# This path is append with the system temp directory.
246246
# It is used to ensure that only one instance of the gateway health Check can run at a time.
247247
FILELOCK_NAME=gateway_healthcheck_init.lock # saved dir in /tmp/gateway_healthcheck_init.lock
248248
# FILELOCK_NAME=somefolder/gateway_healthcheck_init.lock # saved dir in /tmp/somefolder/gateway_healthcheck_init.lock#

DEVELOPING.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,20 @@
55
```bash
66
# Gateway & auth
77
export MCP_GATEWAY_BASE_URL=http://localhost:4444
8-
export MCP_SERVER_CATALOG_URLS=http://localhost:4444/servers/1
8+
export MCP_SERVER_CATALOG_URLS=http://localhost:4444/servers/UUID_OF_SERVER_1
99
export MCP_AUTH_TOKEN="<your_bearer_token>"
1010
```
1111

1212
| Mode | Command | Notes |
1313
| ----------------------------------------------------------- | ---------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
1414
| **SSE (direct)** | `npx @modelcontextprotocol/inspector` | Connects straight to the Gateway's SSE endpoint. |
1515
| **Stdio wrapper** <br/>*(for clients that can't speak SSE)* | `npx @modelcontextprotocol/inspector python -m mcpgateway.wrapper` | Spins up the wrapper **in-process** and points Inspector to its stdio stream. |
16-
| **Stdio wrapper via uv / uvenv** | `npx @modelcontextprotocol/inspector uvenv run python -m mcpgateway.wrapper` | Uses the lightning-fast `uv` virtual-env if installed. |
16+
| **Stdio wrapper via uv / uvx** | `npx @modelcontextprotocol/inspector uvx python -m mcpgateway.wrapper` | Uses the lightning-fast `uv` virtual-env if installed. |
1717

1818
🔍 MCP Inspector boots at **[http://localhost:5173](http://localhost:5173)** - open it in a browser and add:
1919

2020
```text
21-
Server URL: http://localhost:4444/servers/1/sse
21+
Server URL: http://localhost:4444/servers/UUID_OF_SERVER_1/sse
2222
Headers: Authorization: Bearer <your_bearer_token>
2323
```
2424

@@ -31,10 +31,8 @@ remote debugging or for clients that only understand SSE.
3131

3232
```bash
3333
# Using uvx (ships with uv)
34-
npx -y supergateway --stdio "uvx run mcp-server-git"
35-
# OR: using uvenv (pip-based)
36-
pip install uvenv
37-
npx -y supergateway --stdio "uvenv run mcp-server-git"
34+
pip install uv
35+
npx -y supergateway --stdio "uvx mcp-server-git"
3836
```
3937

4038
| Endpoint | Method | URL |

README.md

Lines changed: 123 additions & 110 deletions
Large diffs are not rendered by default.

docs/docs/architecture/adr/011-tool-federation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ We implemented this by making the following changes:
5050

5151
## Consequences
5252

53-
- Two gateways can have the tools with the same native name on the gateway. e.g. `gateway-1-get_current_time` and `gateway-2-get_current_time`.
53+
- Two gateways can have the tools with the same native name on the gateway. e.g. `gateway-1-get_system_time` and `gateway-2-get_system_time`.
5454
- If the tools on a gateway change, they will reflect after **Deactivate/Activate** cycle or after **Edit Gateway** action.
5555

5656
## Alternatives Considered

docs/docs/deployment/tutorials/argocd-helm-deployment-ibm-cloud-iks.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -674,7 +674,7 @@ Add this to your VS Code `settings.json`:
674674
"mcp.servers": {
675675
"mcp-gateway": {
676676
"type": "sse",
677-
"url": "https://mcp-gateway.<CLUSTER_INGRESS_SUBDOMAIN>/servers/1/sse",
677+
"url": "https://mcp-gateway.<CLUSTER_INGRESS_SUBDOMAIN>/servers/UUID_OF_SERVER_1/sse",
678678
"headers": {
679679
"Authorization": "Bearer <MCPGATEWAY_BEARER_TOKEN>"
680680
}
@@ -695,7 +695,7 @@ Add to your Claude Desktop configuration:
695695
"args": ["-m", "mcpgateway.wrapper"],
696696
"env": {
697697
"MCP_AUTH_TOKEN": "<MCPGATEWAY_BEARER_TOKEN>",
698-
"MCP_SERVER_CATALOG_URLS": "https://mcp-gateway.<CLUSTER_INGRESS_SUBDOMAIN>/servers/1"
698+
"MCP_SERVER_CATALOG_URLS": "https://mcp-gateway.<CLUSTER_INGRESS_SUBDOMAIN>/servers/UUID_OF_SERVER_1"
699699
}
700700
}
701701
}
@@ -708,7 +708,7 @@ Add to your Claude Desktop configuration:
708708
from mcpgateway_wrapper import MCPClient
709709
710710
client = MCPClient(
711-
catalog_urls=["https://mcp-gateway.<CLUSTER_INGRESS_SUBDOMAIN>/servers/1"],
711+
catalog_urls=["https://mcp-gateway.<CLUSTER_INGRESS_SUBDOMAIN>/servers/UUID_OF_SERVER_1"],
712712
token="<MCPGATEWAY_BEARER_TOKEN>",
713713
)
714714

docs/docs/development/developer-onboarding.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
???+ check "Python tooling"
1818
- [ ] `pip install --upgrade pip`
19-
- [ ] `uv` and `uvenv` installed - [install uv](https://github.com/astral-sh/uv)
19+
- [ ] `uv` and `uvx` installed - [install uv](https://github.com/astral-sh/uv)
2020
- [ ] `.venv` created with `make venv install install-dev`
2121

2222
???+ check "Additional tools"

docs/docs/faq/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@
33
## ⚡ Quickstart
44

55
???+ example "🚀 How can I install and run MCP Gateway in one command?"
6-
PyPI (pipx / uvenv makes an isolated venv):
6+
PyPI (pipx / uvx makes an isolated venv):
77

88
```bash
99
# Using pipx - pip install pipx
1010
pipx run mcp-contextforge-gateway
1111

12-
# Or uvenv - pip install uvenv (default: admin/changeme)
13-
uvenv run mcp-contextforge-gateway --port 4444
12+
# Or uvx - pip install uv (default: admin/changeme)
13+
uvx mcp-contextforge-gateway --port 4444
1414
```
1515

1616
OCI image (Docker/Podman) - shares host network so localhost works:
@@ -214,7 +214,7 @@
214214

215215
???+ example "🦾 How do I connect GitHub's mcp-server-git via SuperGateway?"
216216
```bash
217-
npx -y supergateway --stdio "uvx run mcp-server-git"
217+
npx -y supergateway --stdio "uvx mcp-server-git"
218218
```
219219

220220
---

docs/docs/overview/features.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ adding auth, caching, federation, and an HTMX-powered Admin UI.
2222
```bash
2323
curl -N -H "Accept: text/event-stream" \
2424
-H "Authorization: Bearer $TOKEN" \
25-
http://localhost:4444/servers/1/sse
25+
http://localhost:4444/servers/UUID_OF_SERVER_1/sse
2626
```
2727

2828
---

docs/docs/overview/quick_start.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -154,8 +154,8 @@ Pick an install method below, generate an auth token, then walk through a real t
154154

155155
```bash
156156
# Spin up a sample MCP time server (SSE, port 8002)
157-
pip install uvenv
158-
npx -y supergateway --stdio "uvenv run mcp_server_time -- --local-timezone=Europe/Dublin" --port 8002 &
157+
pip install uv
158+
npx -y supergateway --stdio "uvx mcp_server_time -- --local-timezone=Europe/Dublin" --port 8002 &
159159
```
160160

161161
```bash
@@ -183,7 +183,7 @@ curl -s -H "Authorization: Bearer $MCP_BEARER_TOKEN" http://localhost:4444/serve
183183
```bash
184184
# Optional: Connect interactively via MCP Inspector
185185
npx -y @modelcontextprotocol/inspector
186-
# Transport SSE → URL http://localhost:4444/servers/1/sse
186+
# Transport SSE → URL http://localhost:4444/servers/UUID_OF_SERVER_1/sse
187187
# Header Authorization → Bearer $MCP_BEARER_TOKEN
188188
```
189189

@@ -193,7 +193,7 @@ npx -y @modelcontextprotocol/inspector
193193

194194
```bash
195195
export MCP_AUTH_TOKEN=$MCP_BEARER_TOKEN
196-
export MCP_SERVER_CATALOG_URLS=http://localhost:4444/servers/1
196+
export MCP_SERVER_CATALOG_URLS=http://localhost:4444/servers/UUID_OF_SERVER_1
197197
python -m mcpgateway.wrapper # behaves as a local MCP stdio server - run from MCP client
198198
```
199199

@@ -206,7 +206,7 @@ Use this in GUI clients (Claude Desktop, Continue, etc.) that prefer stdio. Exam
206206
"command": "python3",
207207
"args": ["-m", "mcpgateway.wrapper"],
208208
"env": {
209-
"MCP_SERVER_CATALOG_URLS": "http://localhost:4444/servers/1",
209+
"MCP_SERVER_CATALOG_URLS": "http://localhost:4444/servers/UUID_OF_SERVER_1",
210210
"MCP_AUTH_TOKEN": "<YOUR_JWT_TOKEN>",
211211
"MCP_TOOL_CALL_TIMEOUT": "120"
212212
}

docs/docs/overview/ui-concepts.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@
1212
You can use [`supergateway`](https://www.npmjs.com/package/supergateway) to wrap any `stdio`-only MCP server and expose it over SSE. Here are example commands:
1313

1414
```bash
15-
npx -y supergateway --stdio "uvenv run mcp-server-git" --port 8001
16-
npx -y supergateway --stdio "uvenv run mcp_server_time -- --local-timezone=Europe/Dublin"
15+
npx -y supergateway --stdio "uvx mcp-server-git" --port 8001
16+
npx -y supergateway --stdio "uvx mcp_server_time -- --local-timezone=Europe/Dublin"
1717
```
1818

1919
✅ **Important:** The gateway must be able to reach the MCP server's network address.

0 commit comments

Comments
 (0)