From e9403c58a76dbd1e88ebd09d91bfecca5b5d675f Mon Sep 17 00:00:00 2001 From: Koichi ITO Date: Fri, 6 Jun 2025 00:34:32 +0900 Subject: [PATCH] [Doc] Tweak an example for `MCP::Resource` in the README `MCP::Resource` doesn't have `text` attribute: https://github.com/modelcontextprotocol/ruby-sdk/blob/v0.1.0/lib/mcp/resource.rb#L8-L13 I've replaced it with attributes that it actually supports. Also, the use of `text: "Hello, world!"` in the example of `server.resources_read_handler` implementation resulted in an unexpected response the first time I worked with `Resource`. While it may not be the best (but better), in my experience using Resources with Cline, `text: params[:uri]` served as a clearer response when interacting with an LLM, making it easier to understand. --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 615c4c44..9b84fc89 100644 --- a/README.md +++ b/README.md @@ -460,9 +460,10 @@ The `MCP::Resource` class provides a way to register resources with the server. ```ruby resource = MCP::Resource.new( - uri: "example.com/my_resource", - mime_type: "text/plain", - text: "Lorem ipsum dolor sit amet" + uri: "https://example.com/my_resource", + name: "My Resource", + description: "Lorem ipsum dolor sit amet", + mime_type: "text/html", ) server = MCP::Server.new( @@ -478,13 +479,13 @@ server.resources_read_handler do |params| [{ uri: params[:uri], mimeType: "text/plain", - text: "Hello, world!", + text: params[:uri], }] end ``` -otherwise 'resources/read' requests will be a no-op. +otherwise `resources/read` requests will be a no-op. ## Releases