Internal Release 0.3.0

Add configurable exception reporter
Avoid leaking tool exceptions by sending them to a configurable exception reporter
Add optional context to pass to tools
Add basic instrumentation data/labels
This commit is contained in:
Topher Bullock 2025-03-24 08:02:32 -04:00
commit 0645351585
6 changed files with 359 additions and 39 deletions

View file

@ -8,8 +8,19 @@ require "model_context_protocol/content"
require "model_context_protocol/resource"
require "model_context_protocol/prompt"
require "model_context_protocol/version"
require "model_context_protocol/configuration"
module ModelContextProtocol
class << self
def configure
yield(configuration)
end
def configuration
@configuration ||= Configuration.new
end
end
class Annotations
attr_reader :audience, :priority

View file

@ -0,0 +1,13 @@
# frozen_string_literal: true
module ModelContextProtocol
class Configuration
attr_accessor :exception_reporter
attr_accessor :instrumentation_callback
def initialize
@exception_reporter = ->(exception, context) {} # Default no-op reporter
@instrumentation_callback = ->(data) {} # Default no-op callback
end
end
end

View file

@ -0,0 +1,24 @@
# frozen_string_literal: true
module ModelContextProtocol
module Instrumentation
def instrument_call(method, &block)
start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
@instrumentation_data = {}
add_instrumentation_data(method:)
result = yield block
end_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
add_instrumentation_data(duration: end_time - start_time)
ModelContextProtocol.configuration.instrumentation_callback.call(@instrumentation_data)
result
end
def add_instrumentation_data(**kwargs)
@instrumentation_data.merge!(kwargs)
end
end
end

View file

@ -1,20 +1,30 @@
# frozen_string_literal: true
require "json_rpc_handler"
require_relative "instrumentation"
module ModelContextProtocol
class Server
class RequestHandlerError < StandardError
def initialize(message, request)
super(message)
@request = request
end
end
PROTOCOL_VERSION = "2024-11-05"
attr_accessor :name, :tools, :prompts, :resources
include Instrumentation
def initialize(name: "model_context_protocol", tools: [], prompts: [], resources: [])
attr_accessor :name, :tools, :prompts, :resources, :context
def initialize(name: "model_context_protocol", tools: [], prompts: [], resources: [], context: nil)
@name = name
@tools = tools.to_h { |t| [t.name, t] }
@prompts = prompts.to_h { |p| [p.name, p] }
@resources = resources
@resource_index = resources.index_by(&:uri)
@context = context
@handlers = {
"resources/list" => method(:list_resources),
"resources/read" => method(:read_resource),
@ -29,18 +39,21 @@ module ModelContextProtocol
def handle(request)
JsonRpcHandler.handle(request) do |method|
handler = case method
when "tools/list"
->(params) { { tools: @handlers["tools/list"].call(params) } }
when "prompts/list"
->(params) { { prompts: @handlers["prompts/list"].call(params) } }
when "resources/list"
->(params) { { resources: @handlers["resources/list"].call(params) } }
else
@handlers[method]
instrument_call(method) do
case method
when "tools/list"
->(params) { { tools: @handlers["tools/list"].call(params) } }
when "prompts/list"
->(params) { { prompts: @handlers["prompts/list"].call(params) } }
when "resources/list"
->(params) { { resources: @handlers["resources/list"].call(params) } }
else
@handlers[method]
end
rescue => e
report_exception(e, { request: request })
raise RequestHandlerError.new("Internal error handling #{request[:method]} request", request)
end
handler
end
end
@ -86,6 +99,7 @@ module ModelContextProtocol
end
def init(request)
add_instrumentation_data(method: "initialize")
{
protocolVersion: PROTOCOL_VERSION,
capabilities: capabilities,
@ -94,47 +108,76 @@ module ModelContextProtocol
end
def list_tools(request)
add_instrumentation_data(method: "tools/list")
@tools.map { |_, tool| tool.to_h }
end
def call_tool(request)
add_instrumentation_data(method: "tools/call")
tool_name = request[:name]
tool = tools[tool_name]
raise "Tool not found #{tool_name}" unless tool
unless tool
add_instrumentation_data(error: :tool_not_found)
raise "Tool not found #{tool_name}"
end
result = tool.call(**request[:arguments])
result.to_h
add_instrumentation_data(tool_name:)
begin
result = tool.call(**request[:arguments], context:)
result.to_h
rescue => e
report_exception(e, { tool_name: tool_name, arguments: request[:arguments] })
add_instrumentation_data(error: :internal_error)
raise RequestHandlerError.new("Internal error calling tool #{tool_name}", request)
end
end
def list_prompts(request)
add_instrumentation_data(method: "prompts/list")
@prompts.map { |_, prompt| prompt.to_h }
end
def get_prompt(request)
add_instrumentation_data(method: "prompts/get")
prompt_name = request[:name]
prompt = @prompts[prompt_name]
unless prompt
add_instrumentation_data(error: :prompt_not_found)
raise "Prompt not found #{prompt_name}"
end
raise "Prompt not found #{prompt_name}" unless prompt
add_instrumentation_data(prompt_name:)
prompt_args = request[:arguments]
prompt.validate_arguments!(prompt_args)
result = prompt.template(prompt_args)
result.to_h
prompt.template(prompt_args).to_h
end
def list_resources(request)
add_instrumentation_data(method: "resources/list")
@resources.map(&:to_h)
end
def read_resource(request)
add_instrumentation_data(method: "resources/read")
resource_uri = request[:uri]
resource = @resource_index[resource_uri]
raise "Resource not found #{resource_uri}" unless resource
unless resource
add_instrumentation_data(error: :resource_not_found)
raise "Resource not found #{resource_uri}"
end
add_instrumentation_data(resource_uri:)
resource.to_h
end
def report_exception(exception, context = {})
ModelContextProtocol.configuration.exception_reporter.call(exception, context)
end
end
end

View file

@ -44,8 +44,8 @@ module ModelContextProtocol
def define(name: nil, description: nil, input_schema: nil, &block)
new(name:, description:, input_schema:).tap do |tool|
tool.define_singleton_method(:call) do |*args|
instance_exec(*args, &block)
tool.define_singleton_method(:call) do |*args, context:|
instance_exec(*args, context:, &block)
end
end
end
@ -59,7 +59,7 @@ module ModelContextProtocol
@input_schema = input_schema || self.class.input_schema_value
end
def call(*args)
def call(*args, context:)
raise NotImplementedError, "Subclasses must implement call"
end

View file

@ -1,5 +1,5 @@
# frozen_string_literal: true
module ModelContextProtocol
VERSION = "0.2.5"
VERSION = "0.3.0"
end