Skip to content

Commit 048b672

Browse files
committed
docs(readme): update production storage limitation section for clarity
1 parent b277fb1 commit 048b672

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,15 @@ This template provides:
1414
- **Example Tool** - Simple echo tool to demonstrate MCP tool implementation
1515
- **Optional OAuth 2.1** - Add authentication when needed with simple configuration
1616

17+
## ⚠️ Production Storage Limitation
18+
19+
[!WARNING]
20+
**Production Storage Limitation**
21+
22+
This template uses in-memory storage for all OAuth codes, tokens, and session data. All such data will be lost on server restart. This approach is suitable for development and testing only. For production deployments, you must implement persistent storage (e.g., database, external cache) to ensure reliability and compliance.
23+
24+
**Do not use in-memory storage in production environments.**
25+
1726
## Quick Start
1827

1928
Get your MCP server running immediately:
@@ -187,6 +196,7 @@ When you need OAuth 2.1 authentication with token validation, it's just a few co
187196
### Quick Setup
188197

189198
1. **Add to your `.env` file:**
199+
190200
```bash
191201
ENABLE_AUTH=true
192202
OAUTH_ISSUER=https://your-provider.com
@@ -205,19 +215,22 @@ Your MCP server now requires valid OAuth tokens for all API requests.
205215
### Use Cases
206216

207217
**Authentication Disabled** (`ENABLE_AUTH=false` or omitted):
218+
208219
- Public MCP servers
209220
- Gateway-protected deployments (Pomerium, nginx with auth, etc.)
210221
- Development and testing
211222
- Internal corporate networks with perimeter security
212223

213224
**Authentication Enabled** (`ENABLE_AUTH=true`):
225+
214226
- Direct OAuth 2.1 with token validation
215-
- Self-contained secure deployment
227+
- Self-contained secure deployment
216228
- Production servers without gateway infrastructure
217229

218230
### OAuth Provider Examples
219231

220232
**Auth0:**
233+
221234
```bash
222235
ENABLE_AUTH=true
223236
OAUTH_ISSUER=https://your-domain.auth0.com
@@ -227,6 +240,7 @@ OAUTH_AUDIENCE=your-api-identifier
227240
```
228241

229242
**Okta:**
243+
230244
```bash
231245
ENABLE_AUTH=true
232246
OAUTH_ISSUER=https://your-domain.okta.com
@@ -235,6 +249,7 @@ OAUTH_CLIENT_SECRET=your-okta-client-secret
235249
```
236250

237251
**Google:**
252+
238253
```bash
239254
ENABLE_AUTH=true
240255
OAUTH_ISSUER=https://accounts.google.com
@@ -252,6 +267,7 @@ curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
252267
### OAuth 2.1 Endpoints (when enabled)
253268

254269
The server automatically provides these endpoints:
270+
255271
- `GET /.well-known/oauth-authorization-server` - OAuth server metadata
256272
- `GET /.well-known/oauth-protected-resource` - Resource server metadata
257273
- `GET /oauth/authorize` - Authorization endpoint (with PKCE)
@@ -260,6 +276,7 @@ The server automatically provides these endpoints:
260276
### Removing Authentication
261277

262278
To completely remove OAuth support:
279+
263280
1. Delete the `src/auth/` directory
264281
2. Remove auth imports from `src/index.ts`
265282
3. Remove OAuth environment variables from `src/config.ts`

0 commit comments

Comments
 (0)