Skip to content

Commit 928293d

Browse files
committed
chore: add streamable http disclaimer
1 parent f8e5000 commit 928293d

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)
@@ -412,6 +414,23 @@ You can disable telemetry using:
412414
- **Command-line argument**: `--telemetry disabled`
413415
- **DO_NOT_TRACK environment variable**: `export DO_NOT_TRACK=1`
414416

417+
#### Streamable HTTP Transport
418+
419+
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.
420+
421+
**Required Security Measures:**
422+
- Implement authentication (e.g., API gateway, reverse proxy)
423+
- Use HTTPS/TLS encryption
424+
- Deploy behind a firewall or in private networks
425+
- Implement rate limiting
426+
- Never expose directly to the internet
427+
428+
**Configuration:**
429+
- **Environment variables**: `export MDB_MCP_TRANSPORT=http`
430+
- **Command-line argument**: `--transport http`
431+
432+
For more details, see [MCP Security Best Practices](https://modelcontextprotocol.io/docs/concepts/transports#security-considerations).
433+
415434
### Atlas API Access
416435

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

0 commit comments

Comments
 (0)