Clarify resource read handler in README #93
+1
−1
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
koic
reviewed
Jul 27, 2025
README.md
Outdated
| @@ -575,7 +575,7 @@ server.resources_read_handler do |params| | |||
| [{ | |||
| uri: params[:uri], | |||
| mimeType: "text/plain", | |||
| text: params[:uri], | |||
| text: "Hello from example resource!" | |||
There was a problem hiding this comment.
As noted in #47, based on my experience, returning a simple string like "Hello" from resources/read was confusing when I first used resources/read. It would be helpful to have a more illustrative example...
There was a problem hiding this comment.
I've updated it have both the message and the URI, which hopefully is clearer.
|
Let's proceed with this. Can you squash your commits into one? |
andyw8
force-pushed
the
andyw8/clarify-resource-read-handler-example-in-readme
branch
from
edebe2d to
ffb04e1
Compare
koic
approved these changes
Jul 30, 2025
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.
This better matches the code in
/examplesand helps illustrate the usage.