mcp 0.8.0 → 0.10.0

data/lib/mcp/transport.rb

@@ -36,8 +36,8 @@ module MCP
       send_response(response) if response
     end
 
-    # Send a notification to the client
-    # Returns true if the notification was sent successfully
+    # Send a notification to the client.
+    # Returns true if the notification was sent successfully.
     def send_notification(method, params = nil)
       raise NotImplementedError, "Subclasses must implement send_notification"
     end

data/lib/mcp/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MCP
-  VERSION = "0.8.0"
+  VERSION = "0.10.0"
 end

data/lib/mcp.rb

@@ -1,36 +1,23 @@
 # frozen_string_literal: true
 
 require_relative "json_rpc_handler"
-require_relative "mcp/annotations"
 require_relative "mcp/configuration"
-require_relative "mcp/content"
-require_relative "mcp/icon"
-require_relative "mcp/instrumentation"
-require_relative "mcp/methods"
-require_relative "mcp/prompt"
-require_relative "mcp/prompt/argument"
-require_relative "mcp/prompt/message"
-require_relative "mcp/prompt/result"
-require_relative "mcp/resource"
-require_relative "mcp/resource/contents"
-require_relative "mcp/resource/embedded"
-require_relative "mcp/resource_template"
-require_relative "mcp/server"
-require_relative "mcp/server/transports/streamable_http_transport"
-require_relative "mcp/server/transports/stdio_transport"
 require_relative "mcp/string_utils"
-require_relative "mcp/tool"
-require_relative "mcp/tool/input_schema"
-require_relative "mcp/tool/output_schema"
-require_relative "mcp/tool/response"
-require_relative "mcp/tool/annotations"
 require_relative "mcp/transport"
 require_relative "mcp/version"
-require_relative "mcp/client"
-require_relative "mcp/client/http"
-require_relative "mcp/client/tool"
 
 module MCP
+  autoload :Annotations, "mcp/annotations"
+  autoload :Client, "mcp/client"
+  autoload :Content, "mcp/content"
+  autoload :Icon, "mcp/icon"
+  autoload :Prompt, "mcp/prompt"
+  autoload :Resource, "mcp/resource"
+  autoload :ResourceTemplate, "mcp/resource_template"
+  autoload :Server, "mcp/server"
+  autoload :ServerSession, "mcp/server_session"
+  autoload :Tool, "mcp/tool"
+
   class << self
     def configure
       yield(configuration)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mcp
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Model Context Protocol
@@ -30,45 +30,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitattributes"
-- ".github/dependabot.yml"
-- ".github/workflows/ci.yml"
-- ".github/workflows/conformance.yml"
-- ".github/workflows/release.yml"
-- ".gitignore"
-- ".rubocop.yml"
-- AGENTS.md
-- CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- Gemfile
 - LICENSE
 - README.md
-- RELEASE.md
-- Rakefile
-- SECURITY.md
-- bin/console
-- bin/generate-gh-pages.sh
-- bin/rake
-- bin/setup
-- conformance/README.md
-- conformance/expected_failures.yml
-- conformance/runner.rb
-- conformance/server.rb
-- dev.yml
-- docs/_config.yml
-- docs/index.md
-- docs/latest/index.html
-- examples/README.md
-- examples/http_client.rb
-- examples/http_server.rb
-- examples/stdio_server.rb
-- examples/streamable_http_client.rb
-- examples/streamable_http_server.rb
 - lib/json_rpc_handler.rb
 - lib/mcp.rb
 - lib/mcp/annotations.rb
 - lib/mcp/client.rb
 - lib/mcp/client/http.rb
+- lib/mcp/client/stdio.rb
 - lib/mcp/client/tool.rb
 - lib/mcp/configuration.rb
 - lib/mcp/content.rb
@@ -76,6 +45,7 @@ files:
 - lib/mcp/instrumentation.rb
 - lib/mcp/logging_message_notification.rb
 - lib/mcp/methods.rb
+- lib/mcp/progress.rb
 - lib/mcp/prompt.rb
 - lib/mcp/prompt/argument.rb
 - lib/mcp/prompt/message.rb
@@ -86,8 +56,11 @@ files:
 - lib/mcp/resource_template.rb
 - lib/mcp/server.rb
 - lib/mcp/server/capabilities.rb
+- lib/mcp/server/transports.rb
 - lib/mcp/server/transports/stdio_transport.rb
 - lib/mcp/server/transports/streamable_http_transport.rb
+- lib/mcp/server_context.rb
+- lib/mcp/server_session.rb
 - lib/mcp/string_utils.rb
 - lib/mcp/tool.rb
 - lib/mcp/tool/annotations.rb
@@ -98,13 +71,12 @@ files:
 - lib/mcp/transport.rb
 - lib/mcp/transports/stdio.rb
 - lib/mcp/version.rb
-- mcp.gemspec
 homepage: https://github.com/modelcontextprotocol/ruby-sdk
 licenses:
 - Apache-2.0
 metadata:
   allowed_push_host: https://rubygems.org
-  changelog_uri: https://github.com/modelcontextprotocol/ruby-sdk/releases/tag/v0.8.0
+  changelog_uri: https://github.com/modelcontextprotocol/ruby-sdk/releases/tag/v0.10.0
   homepage_uri: https://github.com/modelcontextprotocol/ruby-sdk
   source_code_uri: https://github.com/modelcontextprotocol/ruby-sdk
   bug_tracker_uri: https://github.com/modelcontextprotocol/ruby-sdk/issues
@@ -123,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.6
 specification_version: 4
 summary: The official Ruby SDK for Model Context Protocol servers and clients
 test_files: []

data/.gitattributes

@@ -1,4 +0,0 @@
-# See https://git-scm.com/docs/gitattributes for more about git attribute files.
-
-# Mark any vendored files as having been vendored.
-vendor/* linguist-vendored

data/.github/dependabot.yml

@@ -1,6 +0,0 @@
-version: 2
-updates:
-  - package-ecosystem: 'github-actions'
-    directory: '/'
-    schedule:
-      interval: 'weekly'

data/.github/workflows/ci.yml

@@ -1,54 +0,0 @@
-name: CI
-on: [push, pull_request]
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-    strategy:
-      matrix:
-        entry:
-          - { ruby: '2.7', allowed-failure: false }
-          - { ruby: '3.0', allowed-failure: false }
-          - { ruby: '3.1', allowed-failure: false }
-          - { ruby: '3.2', allowed-failure: false }
-          - { ruby: '3.3', allowed-failure: false }
-          - { ruby: '3.4', allowed-failure: false }
-          - { ruby: '4.0', allowed-failure: false }
-          - { ruby: 'head', allowed-failure: true }
-    name: Test Ruby ${{ matrix.entry.ruby }}
-    steps:
-      - uses: actions/checkout@v6
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.entry.ruby }}
-          bundler-cache: true
-      - run: bundle exec rake test
-        continue-on-error: ${{ matrix.entry.allowed-failure }}
-
-  rubocop:
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-    name: RuboCop
-    steps:
-      - uses: actions/checkout@v6
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: 4.0 # Specify the latest supported Ruby version.
-          bundler-cache: true
-      - run: bundle exec rake rubocop
-
-  yard:
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-    name: YARD Documentation
-    steps:
-      - uses: actions/checkout@v6
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: 4.0 # Specify the latest supported Ruby version.
-          bundler-cache: true
-      - run: bundle exec yard --no-output

data/.github/workflows/conformance.yml

@@ -1,29 +0,0 @@
-name: Conformance Tests
-
-on:
-  push:
-    branches: [main]
-  pull_request:
-  workflow_dispatch:
-
-concurrency:
-  group: conformance-${{ github.ref }}
-  cancel-in-progress: true
-
-permissions:
-  contents: read
-
-jobs:
-  server-conformance:
-    runs-on: ubuntu-latest
-    continue-on-error: true
-    steps:
-      - uses: actions/checkout@v6
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: '4.0' # Specify the latest supported Ruby version.
-          bundler-cache: true
-      - uses: actions/setup-node@v4
-        with:
-          node-version: '24' # Specify the latest Node.js version.
-      - run: bundle exec rake conformance

data/.github/workflows/release.yml

@@ -1,57 +0,0 @@
-name: Release new version
-on:
-  push:
-    branches: [main]
-    paths:
-      - "lib/mcp/version.rb"
-jobs:
-  publish_gem:
-    if: github.repository_owner == 'modelcontextprotocol'
-    name: Release Gem Version to RubyGems.org
-    runs-on: ubuntu-latest
-
-    environment: release
-
-    permissions:
-      id-token: write # IMPORTANT: this permission is mandatory for trusted publishing
-      contents: write # IMPORTANT: this permission is required for `rake release` to push the release tag
-    steps:
-      - uses: actions/checkout@v6
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          bundler-cache: true
-          ruby-version: 4.0
-      - uses: rubygems/release-gem@v1
-
-  publish_gh_pages:
-    if: github.repository_owner == 'modelcontextprotocol'
-    name: Publish Documentation to GitHub Pages
-    runs-on: ubuntu-latest
-    needs: [publish_gem]
-
-    permissions:
-      contents: write
-
-    steps:
-      - uses: actions/checkout@v6
-        with:
-          fetch-depth: 0 # Fetch all history for all branches and tags
-
-      - name: Configure Git
-        run: |
-          git config --global user.name "github-actions[bot]"
-          git config --global user.email "github-actions[bot]@users.noreply.github.com"
-
-      - name: Get version tag
-        id: version
-        run: |
-          git fetch --tags
-          TAG=$(git describe --tags --exact-match HEAD)
-          echo "tag=${TAG}" >> $GITHUB_OUTPUT
-
-      - name: Generate GitHub Pages
-        run: ./bin/generate-gh-pages.sh ${{ steps.version.outputs.tag }}
-
-      - name: Push to gh-pages
-        run: git push origin gh-pages

data/.gitignore

@@ -1,11 +0,0 @@
-.ruby-version
-/*.gem
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-Gemfile.lock

data/.rubocop.yml

@@ -1,15 +0,0 @@
-inherit_gem:
-  rubocop-shopify: rubocop.yml
-
-plugins:
-  - rubocop-minitest
-  - rubocop-rake
-
-AllCops:
-  TargetRubyVersion: 2.7
-
-Gemspec/DevelopmentDependencies:
-  Enabled: true
-
-Minitest/LiteralAsActualArgument:
-  Enabled: true

data/AGENTS.md

@@ -1,107 +0,0 @@
-# AGENTS.md
-
-## Project overview
-
-This is the official Ruby SDK for the Model Context Protocol (MCP), implementing both server and client functionality for JSON-RPC 2.0 based communication between LLM applications and context providers.
-
-## Dev environment setup
-
-- Ruby 3.2.0+ required to run the full test suite, including all Sorbet-related features
-- Run `bundle install` to install dependencies
-- Dependencies: `json-schema` >= 4.1 - Schema validation
-
-## Build and test commands
-
-- `bundle install` - Install dependencies
-- `rake test` - Run all tests
-- `rake rubocop` - Run linter
-- `rake` - Run tests and linting (default task)
-- `ruby -I lib -I test test/path/to/specific_test.rb` - Run single test file
-- `gem build mcp.gemspec` - Build the gem
-
-## Testing instructions
-
-- Test files are in `test/` directory with `_test.rb` suffix
-- Run full test suite with `rake test`
-- Run individual tests with `ruby -I lib -I test test/path/to/file_test.rb`
-- Tests should pass before submitting PRs
-
-## Code style guidelines
-
-- Follow RuboCop rules (run `rake rubocop`)
-- Use frozen string literals
-- Follow Ruby community conventions
-- Keep dependencies minimal
-
-## Commit message conventions
-
-- Use conventional commit format when possible
-- Include clear, descriptive commit messages
-- Releases are triggered by updating version in `lib/mcp/version.rb` and merging to main
-
-## Release process
-
-- Follow [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) format in CHANGELOG.md
-- Update CHANGELOG.md before cutting releases
-- Use git history and PR merge commits to construct changelog entries
-- Format entries as: "Terse description of the change (#nnn)"
-- Keep entries in flat list format (no nesting)
-- Git tags mark commits that cut new releases
-- Exclude maintenance PRs that don't concern end users
-- Check upstream remote for PRs if available
-
-## Architecture overview
-
-### Core Components
-
-**MCP::Server** (`lib/mcp/server.rb`):
-
-- Main server class handling JSON-RPC requests
-- Implements MCP protocol methods: initialize, ping, tools/list, tools/call, prompts/list, prompts/get, resources/list, resources/read
-- Supports custom method registration via `define_custom_method`
-- Handles instrumentation, exception reporting, and notifications
-- Uses JsonRpcHandler for request processing
-
-**MCP::Client** (`lib/mcp/client.rb`):
-
-- Client interface for communicating with MCP servers
-- Transport-agnostic design with pluggable transport layers
-- Supports tool listing and invocation
-
-**Transport Layer**:
-
-- `MCP::Server::Transports::StdioTransport` - Command-line stdio transport
-- `MCP::Server::Transports::StreamableHttpTransport` - HTTP with streaming support
-- `MCP::Client::HTTP` - HTTP client transport (requires faraday gem)
-
-**Protocol Components**:
-
-- `MCP::Tool` - Tool definition with input/output schemas and annotations
-- `MCP::Prompt` - Prompt templates with argument validation
-- `MCP::Resource` - Resource registration and retrieval
-- `MCP::Configuration` - Global configuration with exception reporting and instrumentation
-
-### Key Patterns
-
-**Three Ways to Define Components**:
-
-1. Class inheritance (e.g., `class MyTool < MCP::Tool`)
-2. Define methods (e.g., `MCP::Tool.define(name: "my_tool") { ... }`)
-3. Server registration (e.g., `server.define_tool(name: "my_tool") { ... }`)
-
-**Schema Validation**:
-
-- Tools support input_schema and output_schema for JSON Schema validation
-- Protocol version 2025-03-26+ supports tool annotations (destructive_hint, idempotent_hint, etc.)
-- Validation is configurable via `configuration.validate_tool_call_arguments`
-
-**Context Passing**:
-
-- `server_context` hash passed through tool/prompt calls for request-specific data
-- Methods can accept `server_context:` keyword argument for accessing context
-
-### Integration patterns
-
-- **Rails controllers**: Use `server.handle_json(request.body.read)` for HTTP endpoints
-- **Command-line tools**: Use `StdioTransport.new(server).open` for CLI applications
-- **HTTP services**: Use `StreamableHttpTransport` for web-based servers

data/CHANGELOG.md

@@ -1,168 +0,0 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [Unreleased]
-
-## [0.8.0] - 2026-03-03
-
-### Added
-
-- `Content::EmbeddedResource` class for embedded resource content type (#244)
-- `Content::Audio` class for audio content type (#243)
-- `$ref` support in `Tool::Schema` for protocol version 2025-11-25 (#242)
-- MCP conformance test suite (#248)
-
-### Fixed
-
-- Handle `Errno::ECONNRESET` in SSE stream operations (#249)
-- Fix default handler return values to comply with MCP spec (#247)
-- Fix `Prompt#validate_arguments!` crash when arguments are `nil` (#246)
-- Return 202 Accepted for SSE responses per MCP spec (#245)
-- Fix `Content::Image#to_h` to return `mimeType` (camelCase) per MCP spec (#241)
-
-## [0.7.1] - 2026-02-21
-
-### Fixed
-
-- Fix `Resource::Contents#to_h` to use correct property names per MCP spec (#235)
-- Return JSON-RPC protocol errors for unknown tool calls (#231)
-- Fix `logging/setLevel` to return empty hash per MCP specification (#230)
-
-## [0.7.0] - 2026-02-14
-
-### Added
-
-- `logging` support (#103)
-- Protocol version negotiation to server initialization (#223)
-- Tool arguments to instrumentation data (#218)
-- Client info to instrumentation callback (#221)
-- `resource_templates` to `MCP::Client` (#225)
-
-### Changed
-
-- Extract `MCP::Annotations` into a dedicated file (#224)
-
-### Fixed
-
-- `Resource::Embedded` not setting `@resource` in `initialize` (#220)
-
-## [0.6.0] - 2026-01-16
-
-### Changed
-
-- Update licensing to Apache 2.0 for new contributions (#213)
-
-### Fixed
-
-- Omit `icons` from responses when empty or nil to reduce context window usage (#212)
-
-## [0.5.0] - 2026-01-11
-
-### Added
-
-- Protocol specification version "2025-11-25" support (#184)
-- `icons` parameter support (#205)
-- `websiteUrl` parameter in `serverInfo` (#188)
-- `description` parameter in `serverInfo` (#201)
-- `additionalProperties` support for schema validation (#198)
-- "Draft" protocol version to supported versions (#179)
-- `stateless` mode for high availability (#101)
-- Exception messages for tool call errors (#194)
-- Elicitation skeleton (#178)
-- `prompts/list` and `prompts/get` support to client (#163)
-- Accept header validation for HTTP client transport (#207)
-- Ruby 2.7 - Ruby 3.1 support (#206)
-
-### Changed
-
-- Make tool names stricter (#204)
-
-### Fixed
-
-- Symlink path comparison in schema validation (#193)
-- Duplicate tool names across namespaces now raise an error (#199)
-- Tool error handling to follow MCP spec (#165)
-- XSS vulnerability in json_rpc_handler (#175)
-
-## [0.4.0] - 2025-10-15
-
-### Added
-
-- Client resources support with `resources/list` and `resources/read` methods (#160)
-- `_meta` field support for Tool schema (#124)
-- `_meta` field support for Prompt
-- `title` field support for prompt arguments
-- `call_tool_raw` method to client for accessing full tool responses (#149)
-- Structured content support in tool responses (#147)
-- AGENTS.md development guidance documentation (#134)
-- Dependabot configuration for automated dependency updates (#138)
-
-### Changed
-
-- Set default `content` to empty array instead of `nil` (#150)
-- Improved prompt spec compliance (#153)
-- Allow output schema to be array of objects (#144)
-- Return 202 response code for accepted JSON-RPC notifications (#114)
-- Added validation to `MCP::Configuration` setters (#145)
-- Updated metaschema URI format for cross-OS compatibility
-
-### Fixed
-
-- Client tools functionality and test coverage (#166)
-- Client resources test for empty responses (#162)
-- Documentation typos and incorrect examples (#157, #146)
-- Removed redundant transport requires (#154)
-- Cleaned up unused block parameters and magic comments
-
-## [0.3.0] - 2025-09-14
-
-### Added
-
-- Tool output schema support with comprehensive validation (#122)
-- HTTP client transport layer for MCP clients (#28)
-- Tool annotations validation for protocol compatibility (#122)
-- Server instructions support (#87)
-- Title support in server info (#119)
-- Default values for tool annotation hints (#118)
-- Notifications/initialized method implementation (#84)
-
-### Changed
-
-- Make default protocol version the latest specification version (#83)
-- Protocol version validation to ensure valid values (#80)
-- Improved tool handling for tools with no arguments (#85, #86)
-- Better error handling and response API (#109)
-
-### Fixed
-
-- JSON-RPC notification format in Streamable HTTP transport (#91)
-- Errors when title is not specified (#126)
-- Tools with missing arguments handling (#86)
-- Namespacing issues in README examples (#89)
-
-## [0.2.0] - 2025-07-15
-
-### Added
-
-- Custom methods support via `define_custom_method` (#75)
-- Streamable HTTP transport implementation (#33)
-- Tool argument validation against schemas (#43)
-
-### Changed
-
-- Server context is now optional for Tools and Prompts (#54)
-- Improved capability handling and removed automatic capability determination (#61, #63)
-- Refactored architecture in preparation for client support (#27)
-
-### Fixed
-
-- Input schema validation for schemas without required fields (#73)
-- Error handling when sending notifications (#70)
-
-## [0.1.0] - 2025-05-30
-
-Initial release in collaboration with Shopify