Skip to content

Commit a715812

Browse files
author
Faxbot Agent
committed
docs(ui): add Material icons to definition lists (OAuth providers, MCP transports)
1 parent 5ed812f commit a715812

File tree

2 files changed

+37
-37
lines changed

2 files changed

+37
-37
lines changed

docs/mcp/transports.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,49 +2,49 @@
22

33
## HTTP (Node MCP)
44

5-
Port
5+
:material-lan: Port
66
: `3001` (default)
77

8-
Auth
8+
:material-shield-lock: Auth
99
: Protect with `MCP_HTTP_API_KEY`; set strict `MCP_HTTP_CORS_ORIGIN` (no `*` when credentials)
1010

11-
Deployment
11+
:material-cloud-lock: Deployment
1212
: Run behind TLS via reverse proxy; add IP allowlists and rate limits where appropriate
1313

1414
## SSE (Node/Python MCP)
1515

16-
Ports
16+
:material-lan-connect: Ports
1717
: `3002` (Node), `3003` (Python)
1818

19-
Auth
19+
:material-shield-key: Auth
2020
: Require OAuth2/JWT in production. Configure `OAUTH_ISSUER`, `OAUTH_AUDIENCE`, and (optionally) `OAUTH_JWKS_URL`
2121

22-
Deployment
22+
:material-cloud-lock: Deployment
2323
: Run behind TLS; validate tokens against your IdP; set short TTLs
2424

2525
## WebSocket (Node MCP)
2626

27-
Port
27+
:material-websocket: Port
2828
: `3004` (default)
2929

30-
Auth
30+
:material-shield-lock: Auth
3131
: Protect with `MCP_WS_API_KEY` (or reuse `API_KEY`)
3232

33-
Deployment
33+
:material-cloud-lock: Deployment
3434
: Run behind TLS or an authenticated proxy; use only for trusted clients or internal networks
3535

3636
## Stdio
3737

38-
Use case
38+
:material-console-line: Use case
3939
: Best for desktop assistants; avoids base64 limits
4040

41-
Files
41+
:material-file: Files
4242
: Prefer `filePath` for fidelity
4343

4444
## Limits
4545

46-
REST API
46+
:material-upload: REST API
4747
: Raw file limit `MAX_FILE_SIZE_MB` (default 10 MB)
4848

49-
Node MCP HTTP
49+
:material-code-json: Node MCP HTTP
5050
: JSON body limit ~16 MB (base64 payload)

docs/security/oauth-setup.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -30,76 +30,76 @@ OAUTH_JWKS_URL="https://.../jwks.json" # Optional, if not at the standard dis
3030

3131
### Auth0
3232

33-
Issuer
33+
:material-web: Issuer
3434
: `https://YOUR_TENANT.auth0.com`
3535

36-
Audience
36+
:material-target: Audience
3737
: your API Identifier (e.g., `faxbot-mcp`)
3838

39-
JWKS
39+
:material-key-chain: JWKS
4040
: `https://YOUR_TENANT.auth0.com/.well-known/jwks.json`
4141

42-
Docs
42+
:material-book-open-page-variant: Docs
4343
: - Create API (audience): https://auth0.com/docs/get-started/apis/enable-api-authorization
4444
- JWKS and token validation: https://auth0.com/docs/secure/tokens/json-web-tokens/json-web-key-sets
4545
- Client credentials flow: https://auth0.com/docs/get-started/authentication-and-authorization-flow/client-credentials-flow
4646

47-
### Okta
47+
:material-shield-account: Okta
4848

49-
Issuer
49+
:material-web: Issuer
5050
: `https://YOUR_DOMAIN.okta.com/oauth2/default` (or your custom auth server)
5151

52-
Audience
52+
:material-target: Audience
5353
: the custom API audience you configure
5454

55-
JWKS
55+
:material-key-chain: JWKS
5656
: ``${issuer}/v1/keys`` (Okta uses `/v1/keys`, not the generic `/.well-known/jwks.json`)
5757

58-
Docs
58+
:material-book-open-page-variant: Docs
5959
: - Authorization servers & discovery: https://developer.okta.com/docs/guides/customize-authz-server/main/
6060
- Validate access tokens / JWKS: https://developer.okta.com/docs/guides/validate-access-tokens/main/
6161

62-
### Microsoft Entra ID (Azure AD)
62+
:material-microsoft-azure: Microsoft Entra ID (Azure AD)
6363

64-
Issuer
64+
:material-web: Issuer
6565
: `https://login.microsoftonline.com/<TENANT_ID>/v2.0`
6666

67-
Audience
67+
:material-target: Audience
6868
: App Registration → “Expose an API” → Application ID URI (or a custom ID you set)
6969

70-
JWKS
70+
:material-key-chain: JWKS
7171
: `https://login.microsoftonline.com/<TENANT_ID>/discovery/v2.0/keys`
7272

73-
Docs
73+
:material-book-open-page-variant: Docs
7474
: - OIDC discovery: https://learn.microsoft.com/azure/active-directory/develop/v2-protocols-oidc
7575
- App registration / Expose an API: https://learn.microsoft.com/azure/active-directory/develop/quickstart-configure-app-expose-web-apis
7676

77-
### Google Identity (Workforce/Cloud)
77+
:material-google: Google Identity (Workforce/Cloud)
7878

79-
Issuer
79+
:material-web: Issuer
8080
: `https://accounts.google.com`
8181

82-
Audience
82+
:material-target: Audience
8383
: your audience string; ensure your token provider includes it in `aud`
8484

85-
JWKS
85+
:material-key-chain: JWKS
8686
: `https://www.googleapis.com/oauth2/v3/certs`
8787

88-
Docs
88+
:material-book-open-page-variant: Docs
8989
: - OIDC discovery: https://accounts.google.com/.well-known/openid-configuration
9090

91-
### Keycloak (self‑hosted)
91+
:material-shield-lock: Keycloak (self‑hosted)
9292

93-
Issuer
93+
:material-web: Issuer
9494
: `https://YOUR_HOST/realms/YOUR_REALM`
9595

96-
Audience
96+
:material-target: Audience
9797
: client ID or custom audience claim (depends on realm configuration)
9898

99-
JWKS
99+
:material-key-chain: JWKS
100100
: ``${issuer}/protocol/openid-connect/certs``
101101

102-
Docs
102+
:material-book-open-page-variant: Docs
103103
: - OpenID Connect endpoints: https://www.keycloak.org/docs/latest/securing_apps/#openid-connect-endpoints
104104

105105
!!! tip

0 commit comments

Comments
 (0)