docs: polish README for PyCon#31
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the project README to improve developer experience and messaging for “MCP Guard” ahead of PyCon, including clearer positioning, navigation to key quickstarts, safer-looking examples, and ecosystem links.
Changes:
- Renames/rewrites the README header/intro and adds the explicit install command inline.
- Adds a “Quickstarts” navigation section linking to the three quickstart areas.
- Replaces filesystem-based example tools with database-oriented examples and adds a “Related Packages” section plus docs/website/platform links.
- Replace raw SQL execute_query() with parameterized get_user() - Bump list_tables to trust level 1, fix wording to avoid implying level 0 means authenticated - Add db placeholder initialization comment - Replace bare 'go install' with link to install guide
beonde
added a commit
that referenced
this pull request
May 13, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
DX improvements for PyCon readiness:
pip install capiscio-mcp)'open(path),os.listdir(directory)) with safe DB examples — bad optics for a security product README