Skip to content

Commit eb0d9c0

Browse files
authored
Merge pull request #121 from koic/document_mcp_resource_template
[Docs] Document `MCP::ResourceTemplate`
2 parents b982074 + 02b546d commit eb0d9c0

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -560,6 +560,8 @@ This is to avoid potential issues with metric cardinality
560560

561561
MCP spec includes [Resources](https://modelcontextprotocol.io/specification/2025-06-18/server/resources).
562562

563+
### Reading Resources
564+
563565
The `MCP::Resource` class provides a way to register resources with the server.
564566

565567
```ruby
@@ -587,11 +589,29 @@ server.resources_read_handler do |params|
587589
text: "Hello from example resource! URI: #{params[:uri]}"
588590
}]
589591
end
590-
591592
```
592593

593594
otherwise `resources/read` requests will be a no-op.
594595

596+
### Resource Templates
597+
598+
The `MCP::ResourceTemplate` class provides a way to register resource templates with the server.
599+
600+
```ruby
601+
resource_template = MCP::ResourceTemplate.new(
602+
uri_template: "https://example.com/my_resource_template",
603+
name: "my-resource-template",
604+
title: "My Resource Template", # WARNING: This is a `Draft` and is not supported in the `Version 2025-06-18 (latest)` specification.
605+
description: "Lorem ipsum dolor sit amet",
606+
mime_type: "text/html",
607+
)
608+
609+
server = MCP::Server.new(
610+
name: "my_server",
611+
resource_templates: [resource_template],
612+
)
613+
```
614+
595615
## Releases
596616

597617
This gem is published to [RubyGems.org](https://rubygems.org/gems/mcp)

0 commit comments

Comments
 (0)