mcp 0.8.0 → 0.9.0

data/lib/mcp/server.rb

@@ -4,6 +4,9 @@ require_relative "../json_rpc_handler"
 require_relative "instrumentation"
 require_relative "methods"
 require_relative "logging_message_notification"
+require_relative "progress"
+require_relative "server_context"
+require_relative "server/transports"
 
 module MCP
   class ToolNotUnique < StandardError
@@ -96,6 +99,7 @@ module MCP
         Methods::INITIALIZE => method(:init),
         Methods::PING => ->(_) { {} },
         Methods::NOTIFICATIONS_INITIALIZED => ->(_) {},
+        Methods::NOTIFICATIONS_PROGRESS => ->(_) {},
         Methods::LOGGING_SET_LEVEL => method(:configure_logging_level),
 
         # No op handlers for currently unsupported methods
@@ -168,6 +172,21 @@ module MCP
       report_exception(e, { notification: "resources_list_changed" })
     end
 
+    def notify_progress(progress_token:, progress:, total: nil, message: nil)
+      return unless @transport
+
+      params = {
+        "progressToken" => progress_token,
+        "progress" => progress,
+        "total" => total,
+        "message" => message,
+      }.compact
+
+      @transport.send_notification(Methods::NOTIFICATIONS_PROGRESS, params)
+    rescue => e
+      report_exception(e, notification: "progress")
+    end
+
     def notify_log_message(data:, level:, logger: nil)
       return unless @transport
       return unless logging_message_notification&.should_notify?(level)
@@ -419,7 +438,9 @@ module MCP
         end
       end
 
-      call_tool_with_args(tool, arguments)
+      progress_token = request.dig(:_meta, :progressToken)
+
+      call_tool_with_args(tool, arguments, server_context_with_meta(request), progress_token: progress_token)
     rescue RequestHandlerError
       raise
     rescue => e
@@ -445,7 +466,7 @@ module MCP
       prompt_args = request[:arguments]
       prompt.validate_arguments!(prompt_args)
 
-      call_prompt_template_with_args(prompt, prompt_args)
+      call_prompt_template_with_args(prompt, prompt_args, server_context_with_meta(request))
     end
 
     def list_resources(request)
@@ -488,22 +509,37 @@ module MCP
       parameters.any? { |type, name| type == :keyrest || name == :server_context }
     end
 
-    def call_tool_with_args(tool, arguments)
+    def call_tool_with_args(tool, arguments, context, progress_token: nil)
       args = arguments&.transform_keys(&:to_sym) || {}
 
       if accepts_server_context?(tool.method(:call))
+        progress = Progress.new(server: self, progress_token: progress_token)
+        server_context = ServerContext.new(context, progress: progress)
         tool.call(**args, server_context: server_context).to_h
       else
         tool.call(**args).to_h
       end
     end
 
-    def call_prompt_template_with_args(prompt, args)
+    def call_prompt_template_with_args(prompt, args, server_context)
       if accepts_server_context?(prompt.method(:template))
         prompt.template(args, server_context: server_context).to_h
       else
         prompt.template(args).to_h
       end
     end
+
+    def server_context_with_meta(request)
+      meta = request[:_meta]
+      if meta && @server_context.is_a?(Hash)
+        context = @server_context.dup
+        context[:_meta] = meta
+        context
+      elsif meta && @server_context.nil?
+        { _meta: meta }
+      else
+        @server_context
+      end
+    end
   end
 end

data/lib/mcp/server_context.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module MCP
+  class ServerContext
+    def initialize(context, progress:)
+      @context = context
+      @progress = progress
+    end
+
+    def report_progress(progress, total: nil, message: nil)
+      @progress.report(progress, total: total, message: message)
+    end
+
+    def method_missing(name, ...)
+      if @context.respond_to?(name)
+        @context.public_send(name, ...)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(name, include_private = false)
+      @context.respond_to?(name) || super
+    end
+  end
+end

data/lib/mcp/tool.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+require_relative "tool/annotations"
+require_relative "tool/input_schema"
+require_relative "tool/output_schema"
+require_relative "tool/response"
+
 module MCP
   class Tool
     class << self

data/lib/mcp/version.rb

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

data/lib/mcp.rb

@@ -1,36 +1,22 @@
 # 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 :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.9.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,10 @@ 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/string_utils.rb
 - lib/mcp/tool.rb
 - lib/mcp/tool/annotations.rb
@@ -98,13 +70,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.9.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 +94,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