-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Embed code snippets for README from executable examples #1055
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
Open
ihrpr
wants to merge
20
commits into
main
Choose a base branch
from
ihrpr/readme-from-examples
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+1,187
−1,105
Conversation
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
ihrpr
commented
Jun 29, 2025
README.md
Outdated
@@ -419,21 +419,27 @@ def create_thumbnail(image_path: str) -> Image: | |||
|
|||
The Context object gives your tools and resources access to MCP capabilities: | |||
|
|||
<!-- snippet-source examples/servers/everything/src/everything/server.py#L43-L58 --> |
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.
this is only one example for this PR, when we agree on the process, will replace the rest of the Server examples (and later client) in README as separate PRs
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.
We already had an integration test that verifies all current functionality works as expected, so we can use it as both a server example and as the source for README snippets. These snippets will be automatically updated and verified through CI checks. In the future, we'll also add an everything client example and include it in both the README and integration tests.
scripts/update_readme_snippets.py
that extracts code from example files into README<!-- snippet-source path/to/file.py -->
markers to identify updatable sections#L10-L20
)examples/snippets/
with single-feature examples:basic_tool.py
- Simple tool examplebasic_resource.py
- Resource handlingbasic_prompt.py
- Prompt creationtool_progress.py
- Progress reportingsampling.py
- LLM samplingelicitation.py
- User interactioncompletion.py
- Argument completionnotifications.py
- Logging and notificationsmake_everything_fastmcp()
function from tests into a standalone example atexamples/servers/everything/
readme-snippets
job to.github/workflows/shared.yml
to verify snippets are current--check
mode to fail if snippets are outdated