Skip to content

[Docs] Document MCP::ResourceTemplate #121

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.

Sign up for GitHub

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

Merged
koic merged 1 commit into from
Aug 31, 2025
Merged

[Docs] Document MCP::ResourceTemplate #121

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).

### Reading Resources

The `MCP::Resource` class provides a way to register resources with the server.

```ruby
Expand Down Expand Up @@ -587,11 +589,29 @@ server.resources_read_handler do |params|
text: "Hello from example resource! URI: #{params[:uri]}"
}]
end

```

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

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