-
Notifications
You must be signed in to change notification settings - Fork 129
chore: update readme following sec recommendations MCP-198 #547
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR updates the README to improve security by promoting the use of environment variables for sensitive configuration instead of command line arguments. The changes align with security recommendations to prevent sensitive data exposure through process lists and system logs.
- Added security recommendations highlighting the use of environment variables over command line arguments
- Updated all configuration examples to use environment variables for sensitive data (connection strings, API credentials)
- Restructured sections to emphasize secure configuration practices
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Seems reasonable, though note that export foo=bar
works in bash, but not in pwsh or cmd. Would be great if we could show both ways of configuring things - e.g. in <details>
or something similar.
-e MDB_MCP_API_CLIENT_ID \ | ||
-e MDB_MCP_API_CLIENT_SECRET \ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Docker noob here, but does this work by passing through the environment vars?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yup yup. We just need to make sure the env var is set and docker will pull the value from the referred env var name.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
@blva @nirinchev I have added cmd and powershell examples as well and cross referenced them, if any of you want to take another look. |
This commit ensures that our examples promote use of environment variables for providing sensitive configuration options. Additionally we callout, whereever necessary, our recommendation of choosing env variables over command line arguments for the same.
Co-authored-by: Copilot <[email protected]>
e7e34bd
to
86cfd03
Compare
Pull Request Test Coverage Report for Build 17649080824Details
💛 - Coveralls |
Pull Request Test Coverage Report for Build 17649033546Details
💛 - Coveralls |
Proposed changes
This commit ensures that our examples promote use of environment variables for providing sensitive configuration options. Additionally we callout, where ever necessary, our recommendation of choosing env variables over command line arguments for the same.
Checklist