Skip to content

Commit b1f4339

Browse files
committed
chore: add streamable http disclaimer
1 parent 7856bb9 commit b1f4339

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
A Model Context Protocol server for interacting with MongoDB Databases and MongoDB Atlas.
88

9+
> **⚠️ Security Notice:** This server now supports Streamable HTTP transport for remote connections. **HTTP transport is NOT recommended for production use without implementing proper authentication and security measures.** See [Configuration](#configuration) for details.
10+
911
## 📚 Table of Contents
1012

1113
- [🚀 Getting Started](#getting-started)
@@ -359,6 +361,23 @@ You can disable telemetry using:
359361
- **Command-line argument**: `--telemetry disabled`
360362
- **DO_NOT_TRACK environment variable**: `export DO_NOT_TRACK=1`
361363

364+
#### Streamable HTTP Transport
365+
366+
The server supports Streamable HTTP transport for remote connections. **⚠️ Security Warning:** HTTP transport is NOT recommended for production use without implementing proper authentication and security measures.
367+
368+
**Required Security Measures:**
369+
- Implement authentication (e.g., API gateway, reverse proxy)
370+
- Use HTTPS/TLS encryption
371+
- Deploy behind a firewall or in private networks
372+
- Implement rate limiting
373+
- Never expose directly to the internet
374+
375+
**Configuration:**
376+
- **Environment variables**: `export MDB_MCP_TRANSPORT=http`
377+
- **Command-line argument**: `--transport http`
378+
379+
For more details, see [MCP Security Best Practices](https://modelcontextprotocol.io/docs/concepts/transports#security-considerations).
380+
362381
### Atlas API Access
363382

364383
To use the Atlas API tools, you'll need to create a service account in MongoDB Atlas:

0 commit comments

Comments
 (0)