Skip to content

Commit 9179e8f

Browse files
committed
docs(examples): rename MCP_AUTH_PROTOCOL and update guides
Update multiprotocol docs/READMEs to use MCP_AUTH_PROTOCOL (no PHASE wording) and align example instructions with the hardened scripts.
1 parent 3159ef0 commit 9179e8f

File tree

4 files changed

+9
-8
lines changed

4 files changed

+9
-8
lines changed

docs/authorization-multiprotocol.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -467,7 +467,7 @@ See `RequireAuthMiddleware` and PRM handler in `mcp.server.auth` for how these a
467467

468468
- Starts the multi-protocol resource server (`simple-auth-multiprotocol-rs`) on port 8002 with `--api-keys=demo-api-key-12345`. For OAuth, also starts the AS (`simple-auth-as`) on port 9000.
469469
- Waits for PRM: `GET http://localhost:8002/.well-known/oauth-protected-resource/mcp`.
470-
- Runs the client according to `MCP_PHASE2_PROTOCOL`:
470+
- Runs the client according to `MCP_AUTH_PROTOCOL`:
471471
- **api_key** (default): `simple-auth-multiprotocol-client` with `MCP_SERVER_URL=http://localhost:8002/mcp` and `MCP_API_KEY=demo-api-key-12345`. No AS required.
472472
- **oauth**: `simple-auth-client` against the same RS; user completes OAuth in the browser, then runs `list`, `call get_time {}`, `quit`.
473473
- **mutual_tls**: same multiprotocol client without API key; mTLS is a placeholder (no real client cert).

examples/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ for real-world servers.
1111
**API Key**
1212

1313
- Use `MCP_API_KEY` on the client; start RS with `--api-keys=...` (no AS required).
14-
- One-command test (from repo root): `MCP_PHASE2_PROTOCOL=api_key ./scripts/run_phase2_multiprotocol_integration_test.sh`
14+
- One-command test (from repo root): `MCP_AUTH_PROTOCOL=api_key ./scripts/run_phase2_multiprotocol_integration_test.sh`
1515

1616
**OAuth + DPoP**
1717

@@ -20,6 +20,7 @@ for real-world servers.
2020

2121
**Mutual TLS (placeholder)**
2222

23-
- mTLS is a placeholder (no client cert validation). Script: `MCP_PHASE2_PROTOCOL=mutual_tls ./scripts/run_phase2_multiprotocol_integration_test.sh`
23+
- mTLS is a placeholder (no client cert validation). Script: `MCP_AUTH_PROTOCOL=mutual_tls ./scripts/run_phase2_multiprotocol_integration_test.sh`
24+
- mTLS is a placeholder (no client cert validation). Script: `MCP_AUTH_PROTOCOL=mutual_tls ./scripts/run_phase2_multiprotocol_integration_test.sh`
2425

2526
**Client**: [simple-auth-multiprotocol-client](clients/simple-auth-multiprotocol-client/) — supports API Key (`MCP_API_KEY`), OAuth+DPoP (`MCP_USE_OAUTH=1`, `MCP_DPOP_ENABLED=1`), and mTLS placeholder.

examples/clients/simple-auth-multiprotocol-client/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ MCP_SERVER_URL=http://localhost:8002/mcp MCP_API_KEY=demo-api-key-12345 uv run m
2626
```
2727

2828
**One-command test** from repo root:
29-
`MCP_PHASE2_PROTOCOL=api_key ./scripts/run_phase2_multiprotocol_integration_test.sh`
29+
`MCP_AUTH_PROTOCOL=api_key ./scripts/run_phase2_multiprotocol_integration_test.sh`
3030
starts the resource server and this client with API Key; at `mcp>` run `list`, `call get_time {}`, `quit`.
3131

3232
## Running with OAuth + DPoP
@@ -51,10 +51,10 @@ Complete OAuth in the browser; then at `mcp>` run `list`, `call get_time {}`, `q
5151

5252
Mutual TLS is a **placeholder** in this example: the client registers the `mutual_tls` protocol but does **not** perform client certificate authentication. Selecting mTLS will show a "not implemented" style message.
5353

54-
- **`MCP_PHASE2_PROTOCOL=mutual_tls`** (with the phase2 script) runs this client in mTLS mode; the client will start but mTLS auth is not implemented.
54+
- **`MCP_AUTH_PROTOCOL=mutual_tls`** (with the phase2 script) runs this client in mTLS mode; the client will start but mTLS auth is not implemented.
5555

5656
**One-command test** from repo root:
57-
`MCP_PHASE2_PROTOCOL=mutual_tls ./scripts/run_phase2_multiprotocol_integration_test.sh`
57+
`MCP_AUTH_PROTOCOL=mutual_tls ./scripts/run_phase2_multiprotocol_integration_test.sh`
5858

5959
## Commands
6060

examples/servers/simple-auth-multiprotocol/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ You can run the Resource Server **without** the Authorization Server when using
3636
3. At the `mcp>` prompt, run `list`, `call get_time {}`, then `quit`.
3737

3838
**One-command verification** (from repo root):
39-
`MCP_PHASE2_PROTOCOL=api_key ./scripts/run_phase2_multiprotocol_integration_test.sh`
39+
`MCP_AUTH_PROTOCOL=api_key ./scripts/run_phase2_multiprotocol_integration_test.sh`
4040
This starts the RS, then the client with API Key; complete the session with `list`, `call get_time {}`, `quit`.
4141

4242
## Running with DPoP (OAuth + DPoP)
@@ -66,7 +66,7 @@ Mutual TLS is a **placeholder** in this example: the server accepts the `mutual_
6666

6767
- **Server**: No extra flags; `auth_protocols` already includes `mutual_tls`.
6868
- **Client** (from repo root):
69-
`MCP_PHASE2_PROTOCOL=mutual_tls ./scripts/run_phase2_multiprotocol_integration_test.sh`
69+
`MCP_AUTH_PROTOCOL=mutual_tls ./scripts/run_phase2_multiprotocol_integration_test.sh`
7070
The client will start but mTLS authentication is not implemented in this example.
7171

7272
## Options

0 commit comments

Comments
 (0)