hub_kernel-mcp 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fdf5562d9d62588f25ee064ae1571430d08a6ac2c452b957b1df4784f5c9cc1d
-  data.tar.gz: e122d851e02746457f5f4232eb118f3a2cd21100fb1931827f5af939c234076e
+  metadata.gz: 363a48c785a072c9ba3c744969cb93de55d2514c0e68008873a9bb7312fd8fb0
+  data.tar.gz: c3f27a9e3a246c1742cd101415b286f7096dfeed8e52bb618e604b7e5127060b
 SHA512:
-  metadata.gz: 120c5a8941826f02ceea5d9cf251d3ec30e0061f4282010526fd067da2f5b7fdfde270d90900842b58cefed05aafb9decf8acb52c49d05131eaf8ab0fe4a499d
-  data.tar.gz: 9082038898f81950d9a26c9973bc8d05e5d6769485d43f20eea358df2d274a388012fb3a1cd24393b88c73a4fecb2d3330e68923ec296f6ec34f6b0d9860b97c
+  metadata.gz: 58097086aeed03bd87cb0d10ae8b554b2963823300f1d70f85f8efd7ddcaf5d195eaf2e397edf5cad03fc98966fa754fe0eb489251bc3e3c552178d50d5cc292
+  data.tar.gz: 581abee68889b126bb28291ad58329fab0b7d5c48e7bef6be0860a766105fde7afe633d5ca72e715defe35721268f7572dc4e35421b3050c6d2be752cbf6c2f4

data/README.md

@@ -21,9 +21,16 @@ serves:
 ```ruby
 Rails.application.config.to_prepare do
   HubKernel::Interface.hubs = [ Supplies, { "money" => Billing::Ledger } ]
+  HubKernel::Mcp.check!
 end
 ```
 
+`HubKernel::Mcp.check!` raises `HubKernel::Mcp::UnservableHubError` naming every problem
+in one error. It names each problem hub_kernel-interface's own check finds in the served
+list, a served name holding two underscores in a row, and a tool whose name holds a
+character other than a letter, a digit, an underscore or a hyphen or is longer than 64
+characters. Inside `to_prepare` it runs again after every code reload.
+
 Mount the engine:
 
 ```ruby
@@ -40,9 +47,17 @@ Each tool is named `<hub>__<method>`, where the hub part is the name the hub is
 its input schema names the values the method takes:
 
 ```json
-{ "name": "supplies__price_of", "inputSchema": { "type": "object", "properties": { "item": {} } } }
+{
+  "name": "supplies__price_of",
+  "description": "Reads data from the supplies hub.",
+  "inputSchema": { "type": "object", "properties": { "item": {} } },
+  "annotations": { "readOnlyHint": true }
+}
 ```
 
+A tool for a method that writes has `readOnlyHint` set to false and a description saying it
+changes data, so a client can ask before it calls one.
+
 `tools/call` runs the hub method a tool names, for the person and account the host's methods
 give, and returns the method's answer as JSON text:
 

data/app/controllers/hub_kernel/mcp/messages_controller.rb

@@ -33,7 +33,7 @@ module HubKernel
         end
       end
 
-      def tool(served_name, exposure) = { name: "#{served_name}__#{exposure.name}", inputSchema: { type: "object", properties: exposure.takes.index_with { {} } } }
+      def tool(served_name, exposure) = { name: "#{served_name}__#{exposure.name}", description: description(served_name, exposure), inputSchema: { type: "object", properties: exposure.takes.index_with { {} } }, annotations: { readOnlyHint: !exposure.writes } }
 
       def called
         served_name, method_name = tool_name.split("__", 2)
@@ -48,6 +48,8 @@ module HubKernel
 
       def arguments = params.dig(:params, :arguments)&.to_unsafe_h.to_h.deep_symbolize_keys
 
+      def description(served_name, exposure) = exposure.writes ? "Changes data in the #{served_name} hub." : "Reads data from the #{served_name} hub."
+
       def caller_person = send(HubKernel::Mcp.person_method)
 
       def caller_account = send(HubKernel::Mcp.account_method)

data/lib/hub_kernel/mcp/version.rb

@@ -1,5 +1,5 @@
 module HubKernel
   module Mcp
-    VERSION = "0.2.0"
+    VERSION = "0.4.0"
   end
 end

data/lib/hub_kernel/mcp.rb

@@ -4,8 +4,46 @@ require "hub_kernel/mcp/engine"
 
 module HubKernel
   module Mcp
+    UnservableHubError = HubKernel::Interface::UnservableHubError
+
     mattr_accessor :base_controller, default: "ActionController::API"
     mattr_accessor :person_method
     mattr_accessor :account_method
+
+    def self.check!
+      problems = shared_problems + doubled_underscores + unlisted_characters + long_names
+      raise UnservableHubError, problems.join("\n") if problems.any?
+    end
+
+    def self.shared_problems
+      HubKernel::Interface.check!
+      []
+    rescue UnservableHubError => error
+      error.message.split("\n")
+    end
+
+    def self.doubled_underscores
+      HubKernel::Interface.served.select { |name, _hub| name.include?("__") }.map do |name, hub|
+        "#{hub.name} is served at #{name}, which holds two underscores in a row"
+      end
+    end
+
+    def self.unlisted_characters
+      tool_names.grep_v(/\A[A-Za-z0-9_-]*\z/).map do |name|
+        "The tool #{name} holds a character other than a letter, a digit, an underscore or a hyphen"
+      end
+    end
+
+    def self.long_names
+      tool_names.select { |name| name.length > 64 }.map { |name| "The tool #{name} is longer than 64 characters" }
+    end
+
+    def self.tool_names
+      HubKernel::Interface.served.select { |_name, hub| hub.respond_to?(:exposures) }.flat_map do |served_name, hub|
+        hub.exposures.map { |exposure| "#{served_name}__#{exposure.name}" }
+      end
+    end
+
+    private_class_method :shared_problems, :doubled_underscores, :unlisted_characters, :long_names, :tool_names
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hub_kernel-mcp
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - tylercschneider
@@ -29,14 +29,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.6'
 description: hub_kernel-mcp serves the methods every hub a host serves exposes as
   MCP tools at one address, with every call going through the host's sign-in, permission
   check and account scope.