Skip to content

Commit 9b9adde

Browse files
authored
docs: move MCP Gateway comparison after Quickstart section (#65)
Reorganize README structure to present quickstart instructions before the comparison section for better user experience
1 parent ac8f0c3 commit 9b9adde

1 file changed

Lines changed: 19 additions & 19 deletions

File tree

README.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -15,25 +15,6 @@
1515

1616
📖 **For detailed usage, configuration, and examples, see the [Documentation](https://sigbit.github.io/mcp-auth-proxy/)**
1717

18-
## Why not MCP Gateway?
19-
20-
MCP Gateway: **A hub for operating multiple MCP servers together** (container isolation, catalog integration)
21-
mcp-auth-proxy: **A lightweight proxy that adds authentication in front of any MCP server** (+ stdio→HTTP(S) conversion, optional)
22-
23-
### When to choose `mcp-auth-proxy`
24-
25-
- **You just want to add auth to one or a few MCPs** (enforce OAuth/OIDC/password with zero changes to the server)
26-
- **Container operations and catalog integration aren’t needed** (ideal for small setups, testing/PoC, or one-off exposure)
27-
28-
### When to choose MCP Gateway
29-
30-
- **Operating many MCPs at organizational scale** (provisioning, policy/permissions, audit, centralized logs)
31-
- **You want operations features** like container isolation and catalog integration
32-
33-
_Note_: They are not mutually exclusive. You can **put `mcp-auth-proxy` in front of a Gateway's public endpoint to enforce authentication** if the Gateway itself doesn't handle it.
34-
35-
**TL;DR:** Orchestrate many → Gateway / Expose safely & quickly → mcp-auth-proxy
36-
3718
## Quickstart
3819

3920
> Domain binding & 80/443 must be accessible from outside.
@@ -55,6 +36,25 @@ That's it! Your HTTP endpoint is now available at `https://{your-domain}/mcp`.
5536
- stdio (when a command is specified): MCP endpoint is https://{your-domain}/mcp.
5637
- SSE/HTTP (when a URL is specified): MCP endpoint uses the backend’s original path (no conversion).
5738

39+
## Why not MCP Gateway?
40+
41+
MCP Gateway: **A hub for operating multiple MCP servers together** (container isolation, catalog integration)
42+
mcp-auth-proxy: **A lightweight proxy that adds authentication in front of any MCP server** (+ stdio→HTTP(S) conversion, optional)
43+
44+
### When to choose `mcp-auth-proxy`
45+
46+
- **You just want to add auth to one or a few MCPs** (enforce OAuth/OIDC/password with zero changes to the server)
47+
- **Container operations and catalog integration aren’t needed** (ideal for small setups, testing/PoC, or one-off exposure)
48+
49+
### When to choose MCP Gateway
50+
51+
- **Operating many MCPs at organizational scale** (provisioning, policy/permissions, audit, centralized logs)
52+
- **You want operations features** like container isolation and catalog integration
53+
54+
_Note_: They are not mutually exclusive. You can **put `mcp-auth-proxy` in front of a Gateway's public endpoint to enforce authentication** if the Gateway itself doesn't handle it.
55+
56+
**TL;DR:** Orchestrate many → Gateway / Expose safely & quickly → mcp-auth-proxy
57+
5858
## Verified MCP Client
5959

6060
| MCP Client | Status | Notes |

0 commit comments

Comments
 (0)