mcpspan 0.6.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 184dd27a9089025a9a5a1e7bad3558248a4d252d1d8b2cb84553b575f35fe2c3
-  data.tar.gz: 7d4c2bf7e4f43096ff05268dcd3ef815b92a495cbed763126aee28f3ad05b161
+  metadata.gz: 4267cb7cc680792a32f97df729a4743b74177b13d378f24ee6a74077e157eb58
+  data.tar.gz: 98751e6814b662247d7b520e45685706626c21216af97576f9e35e40ae0f0428
 SHA512:
-  metadata.gz: a83a5bd3eacaaa255feb8d8502f9a6fb37b4d35bab3146d7c05ec9954357cdae718df0adb74898118469421fca78e8bea966e9cad4f9fbb68d5e62f738a88ea6
-  data.tar.gz: 7649be55373354f59a4df45029b863435c4744fdfc4439b42021293546c7f3c24e5a805add9d97d8cce18d0a44f9aea0789a14101bab5a7e881104ab2719ef6e
+  metadata.gz: bf3842454c66ddabba4d2f27e95c8a3d74542fb32c28c1eab2c8dd6975b7c4565959f8608965f943768dd297a5fe31756cea0b8c358597399ec1ab0653a61fc5
+  data.tar.gz: 47d167afb98ce0155bf85c8fb93c3ea9f71abb8707c3f8f5d5b25f4039900c9f11b6682e4fabc5afa69b93f2cf8ed163405722100531d2c8fb8a44ad67b1b20d

data/README.md

@@ -164,7 +164,10 @@ tool's definition as your server lists it (its name, title, description and
 input schema, hashed, so the dashboard can mark when you changed it), for a call your
 server refused for its arguments the names of those that did not match the
 tool's schema (never what was sent), which
-client called, and the SDK version. For a resource or a prompt, the same, under the name it was
+client called, and the SDK version. When your server answers a request for
+its list of tools: each tool's name, that fingerprint and the size of its
+definition in bytes, once per session, so the dashboard can show what the
+list costs an agent and which tools are never called. For a resource or a prompt, the same, under the name it was
 registered with: never the address a client read, only its template or, for
 an address the server does not have, its scheme.
 

data/lib/mcpspan/collector.rb

@@ -159,6 +159,40 @@ module McpSpan
         nil
       end
 
+      # Tools in a listing beyond this are left out (contract, 3.11).
+      MAX_LISTED_TOOLS = 500
+
+      # Records what the server answered to `tools/list` (contract, 3.11): the tools' names, fingerprints and sizes,
+      # once per session for the same answer, leaving out the tools the block says are excluded. `call` carries the
+      # client, the session and the versions. It never blocks on the network.
+      def record_listing(call, tools)
+        reporter = @reporter
+        return if reporter.nil? || call.nil?
+
+        shown = tools.reject { |name, _, _| yield(name) }.first(MAX_LISTED_TOOLS).map do |name, hash, bytes|
+          { name: Text.truncate(name, Text::MAX_NAME), definitionHash: hash, definitionBytes: bytes }
+        end
+        signature = shown.map { |tool| "#{tool[:name]}\0#{tool[:definitionHash]}" }.join("\0")
+        return unless Listings.first?(call.session_id, signature)
+
+        reporter.record(Event.new(
+          id: SecureRandom.uuid,
+          kind: "listing",
+          tool_name: "tools/list",
+          duration_ms: 0,
+          success: true,
+          client_type: "unknown",
+          client_name: Text.client_name(call.client_name),
+          client_version: Text.version(call.client_version),
+          server_version: Text.version(call.server_version),
+          timestamp: call.timestamp.strftime("%Y-%m-%dT%H:%M:%S.%LZ"),
+          session_id: call.session_id,
+          listed_tools: shown,
+        ))
+      rescue StandardError
+        nil
+      end
+
       # Which declared arguments a refusal was over (contract, 3.10), or nil when none were found.
       def refused_names(call)
         names = ArgumentChecks.invalid(Definitions.schema_of(call.tool_name), call.arguments)

data/lib/mcpspan/definitions.rb

@@ -29,19 +29,23 @@ module McpSpan
         @lock.synchronize { @schemas[tool_name] }
       end
 
-      # Notes every tool in a listing, in whatever key style the gem keeps them. Never raises.
+      # Notes every tool in a listing, in whatever key style the gem keeps them, and returns them in its order as
+      # name, fingerprint and size (contract, 3.11). Never raises.
       def note(tools)
+        found = []
         JSON.parse(JSON.generate(Array(tools))).each do |tool|
           next unless tool.is_a?(Hash) && tool["name"].is_a?(String)
 
-          fingerprint = hash(tool)
+          written = fingerprint(tool)
           @lock.synchronize do
-            @listed[tool["name"]] = fingerprint if fingerprint
+            @listed[tool["name"]] = written[0] if written
             @schemas[tool["name"]] = tool["inputSchema"]
           end
+          found << [tool["name"], *written] if written
         end
+        found
       rescue StandardError
-        nil
+        found || []
       end
 
       # For tests: forgets every listing.
@@ -55,8 +59,15 @@ module McpSpan
       # The first 16 hex characters of the SHA-256 of the tool's name, title, description and input schema, as
       # canonical JSON; nil for a definition that cannot be written so.
       def hash(tool)
+        fingerprint(tool)&.first
+      end
+
+      # The fingerprint, and the size in UTF-8 bytes of the canonical JSON it is taken from (contract, 3.11); nil for
+      # a definition that cannot be written so.
+      def fingerprint(tool)
         hashed = HASHED.each_with_object({}) { |field, out| out[field] = tool[field] unless tool[field].nil? }
-        Digest::SHA256.hexdigest(canonical(hashed))[0, 16]
+        written = canonical(hashed)
+        [Digest::SHA256.hexdigest(written)[0, 16], written.bytesize]
       rescue StandardError
         nil
       end

data/lib/mcpspan/event.rb

@@ -7,7 +7,7 @@ module McpSpan
   Event = Struct.new(
     :id, :kind, :tool_name, :duration_ms, :success, :error_source, :error_type, :error_message,
     :client_type, :client_name, :client_version, :server_version, :response_bytes, :definition_hash, :repeated,
-    :invalid_arguments, :timestamp, :session_id, :parameters,
+    :invalid_arguments, :timestamp, :session_id, :parameters, :listed_tools,
     keyword_init: true,
   ) do
     # The event as the API takes it, leaving absent fields out rather than sending them as null.
@@ -33,6 +33,8 @@ module McpSpan
         sdkVersion: VERSION,
         sessionId: session_id,
         parameters: parameters,
+        # On a listing: the tools the server listed, in its order (contract, 3.11).
+        listedTools: listed_tools,
       }.compact
     end
 

data/lib/mcpspan/instrumentation.rb

@@ -52,18 +52,32 @@ module McpSpan
       original = handlers.is_a?(Hash) ? handlers[method] : nil
       return unless original.respond_to?(:call) && original.respond_to?(:parameters)
 
-      note = lambda do |result|
-        Definitions.note(result[:tools] || result["tools"]) if Collector.collecting? && result.is_a?(Hash)
+      contextual = original.parameters.any? { |kind, name| %i[key keyreq].include?(kind) && name == :server_context }
+      # Always asking for the context, which is where the session and the client are; the gem's own handler gets
+      # it only if it asked for it too.
+      handlers[method] = lambda do |params, server_context: nil|
+        result = contextual ? original.call(params, server_context: server_context) : original.call(params)
+        record_listing(server, result, server_context) if Collector.collecting? && result.is_a?(Hash)
         result
       end
-      contextual = original.parameters.any? { |kind, name| %i[key keyreq].include?(kind) && name == :server_context }
-      handlers[method] = if contextual
-                           lambda do |params, server_context: nil|
-                             note.call(original.call(params, server_context: server_context))
-                           end
-                         else
-                           ->(params) { note.call(original.call(params)) }
-                         end
+    rescue StandardError
+      nil
+    end
+
+    # Notes a listing's fingerprints (contract, 3.8) and records it (3.11). Never raises.
+    def record_listing(server, result, server_context)
+      tools = Definitions.note(result[:tools] || result["tools"])
+      session = server_context&.instance_variable_get(:@notification_target)
+      envelope = server_context.respond_to?(:envelope) ? server_context.envelope : nil
+      call = Collector.begin_call(
+        "tools/list",
+        arguments: nil,
+        session_id: session_id(session),
+        server_version: server_version(server),
+        kind: "listing",
+        **client(envelope, session, server),
+      )
+      Collector.record_listing(call, tools) { |name| excluded?(server.tools[name], name) }
     rescue StandardError
       nil
     end

data/lib/mcpspan/listings.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module McpSpan
+  # The listings already sent for each session, so the same answer to `tools/list` is sent once per session
+  # (contract, 3.11). A client lists the tools at the start of a session and often again; the count that matters is
+  # the sessions that were shown the tools, not how often they asked.
+  module Listings
+    # Sessions kept, the oldest forgotten first.
+    MAX_SESSIONS = 10_000
+
+    @sent = {}
+    @lock = Mutex.new
+
+    class << self
+      # Whether a listing is new for its session, noting it as sent. A listing with no session always is.
+      def first?(session_id, signature)
+        return true if session_id.nil?
+
+        @lock.synchronize do
+          signatures = @sent.delete(session_id) || {}
+          new = !signatures.key?(signature)
+          signatures[signature] = true
+          @sent[session_id] = signatures
+          @sent.delete(@sent.keys.first) if @sent.size > MAX_SESSIONS
+          new
+        end
+      end
+
+      # For tests: forgets every listing sent.
+      def forget
+        @lock.synchronize { @sent.clear }
+      end
+    end
+  end
+end

data/lib/mcpspan/version.rb

@@ -2,5 +2,5 @@
 
 module McpSpan
   # The SDK's own version, reported with every event.
-  VERSION = "0.6.0"
+  VERSION = "0.8.1"
 end

data/lib/mcpspan.rb

@@ -9,6 +9,7 @@ require_relative "mcpspan/collector"
 require_relative "mcpspan/definitions"
 require_relative "mcpspan/argument_checks"
 require_relative "mcpspan/repeats"
+require_relative "mcpspan/listings"
 require_relative "mcpspan/instrumentation"
 require_relative "mcpspan/primitives"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mcpspan
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Kacper Zatoń
@@ -24,6 +24,7 @@ files:
 - lib/mcpspan/definitions.rb
 - lib/mcpspan/event.rb
 - lib/mcpspan/instrumentation.rb
+- lib/mcpspan/listings.rb
 - lib/mcpspan/primitives.rb
 - lib/mcpspan/repeats.rb
 - lib/mcpspan/reporter.rb