modelcontextprotocol/ruby-sdk
Watch
1
0
Fork
You've already forked ruby-sdk
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[Docs] Document MCP::ResourceTemplate

Browse source 
This PR documents `MCP::ResourceTemplate`.

Resolves #88.
This commit is contained in:
Koichi ITO 2025-08-31 00:13:56 +09:00
commit 02b546dcda
1 changed files with 21 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -560,6 +560,8 @@ This is to avoid potential issues with metric cardinality
MCP spec includes [Resources](https://modelcontextprotocol.io/specification/2025-06-18/server/resources). MCP spec includes [Resources](https://modelcontextprotocol.io/specification/2025-06-18/server/resources).
### Reading Resources
The `MCP::Resource` class provides a way to register resources with the server. The `MCP::Resource` class provides a way to register resources with the server.
```ruby ```ruby
@ -587,11 +589,29 @@ server.resources_read_handler do |params|
text: "Hello from example resource! URI: #{params[:uri]}" text: "Hello from example resource! URI: #{params[:uri]}"
}] }]
end end
``` ```
otherwise `resources/read` requests will be a no-op. otherwise `resources/read` requests will be a no-op.
### Resource Templates
The `MCP::ResourceTemplate` class provides a way to register resource templates with the server.
```ruby
resource_template = MCP::ResourceTemplate.new(
uri_template: "https://example.com/my_resource_template",
name: "my-resource-template",
title: "My Resource Template", # WARNING: This is a `Draft` and is not supported in the `Version 2025-06-18 (latest)` specification.
description: "Lorem ipsum dolor sit amet",
mime_type: "text/html",
)
server = MCP::Server.new(
name: "my_server",
resource_templates: [resource_template],
)
```
## Releases ## Releases
This gem is published to [RubyGems.org](https://rubygems.org/gems/mcp) This gem is published to [RubyGems.org](https://rubygems.org/gems/mcp)