ruby-utcp 1.1.0

data/examples/generated/utcp_pb2.py

@@ -0,0 +1,46 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# NO CHECKED-IN PROTOBUF GENCODE
+# source: utcp.proto
+# Protobuf Python Version: 7.35.1
+"""Generated protocol buffer code."""
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import runtime_version as _runtime_version
+from google.protobuf import symbol_database as _symbol_database
+from google.protobuf.internal import builder as _builder
+_runtime_version.ValidateProtobufRuntimeVersion(
+    _runtime_version.Domain.PUBLIC,
+    7,
+    35,
+    1,
+    '',
+    'utcp.proto'
+)
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\nutcp.proto\x12\x06grpcpb\"\x07\n\x05\x45mpty\")\n\x04Tool\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\x13\n\x0b\x64\x65scription\x18\x02 \x01(\t\"6\n\x06Manual\x12\x0f\n\x07version\x18\x01 \x01(\t\x12\x1b\n\x05tools\x18\x02 \x03(\x0b\x32\x0c.grpcpb.Tool\"2\n\x0fToolCallRequest\x12\x0c\n\x04tool\x18\x01 \x01(\t\x12\x11\n\targs_json\x18\x02 \x01(\t\"\'\n\x10ToolCallResponse\x12\x13\n\x0bresult_json\x18\x01 \x01(\t2\xbf\x01\n\x0bUTCPService\x12*\n\tGetManual\x12\r.grpcpb.Empty\x1a\x0e.grpcpb.Manual\x12=\n\x08\x43\x61llTool\x12\x17.grpcpb.ToolCallRequest\x1a\x18.grpcpb.ToolCallResponse\x12\x45\n\x0e\x43\x61llToolStream\x12\x17.grpcpb.ToolCallRequest\x1a\x18.grpcpb.ToolCallResponse0\x01\x62\x06proto3')
+
+_globals = globals()
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'utcp_pb2', _globals)
+if not _descriptor._USE_C_DESCRIPTORS:
+  DESCRIPTOR._loaded_options = None
+  _globals['_EMPTY']._serialized_start=22
+  _globals['_EMPTY']._serialized_end=29
+  _globals['_TOOL']._serialized_start=31
+  _globals['_TOOL']._serialized_end=72
+  _globals['_MANUAL']._serialized_start=74
+  _globals['_MANUAL']._serialized_end=128
+  _globals['_TOOLCALLREQUEST']._serialized_start=130
+  _globals['_TOOLCALLREQUEST']._serialized_end=180
+  _globals['_TOOLCALLRESPONSE']._serialized_start=182
+  _globals['_TOOLCALLRESPONSE']._serialized_end=221
+  _globals['_UTCPSERVICE']._serialized_start=224
+  _globals['_UTCPSERVICE']._serialized_end=415
+# @@protoc_insertion_point(module_scope)

data/examples/generated/utcp_pb2_grpc.py

@@ -0,0 +1,183 @@
+# Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!
+"""Client and server classes corresponding to protobuf-defined services."""
+import grpc
+import warnings
+
+import utcp_pb2 as utcp__pb2
+
+GRPC_GENERATED_VERSION = '1.83.1'
+GRPC_VERSION = grpc.__version__
+_version_not_supported = False
+
+try:
+    from grpc._utilities import first_version_is_lower
+    _version_not_supported = first_version_is_lower(GRPC_VERSION, GRPC_GENERATED_VERSION)
+except ImportError:
+    _version_not_supported = True
+
+if _version_not_supported:
+    raise RuntimeError(
+        f'The grpc package installed is at version {GRPC_VERSION},'
+        + ' but the generated code in utcp_pb2_grpc.py depends on'
+        + f' grpcio>={GRPC_GENERATED_VERSION}.'
+        + f' Please upgrade your grpc module to grpcio>={GRPC_GENERATED_VERSION}'
+        + f' or downgrade your generated code using grpcio-tools<={GRPC_VERSION}.'
+    )
+
+
+class UTCPServiceStub:
+    """Missing associated documentation comment in .proto file."""
+
+    def __init__(self, channel):
+        """Constructor.
+
+        Args:
+            channel: A grpc.Channel.
+        """
+        self.GetManual = channel.unary_unary(
+                '/grpcpb.UTCPService/GetManual',
+                request_serializer=utcp__pb2.Empty.SerializeToString,
+                response_deserializer=utcp__pb2.Manual.FromString,
+                _registered_method=True)
+        self.CallTool = channel.unary_unary(
+                '/grpcpb.UTCPService/CallTool',
+                request_serializer=utcp__pb2.ToolCallRequest.SerializeToString,
+                response_deserializer=utcp__pb2.ToolCallResponse.FromString,
+                _registered_method=True)
+        self.CallToolStream = channel.unary_stream(
+                '/grpcpb.UTCPService/CallToolStream',
+                request_serializer=utcp__pb2.ToolCallRequest.SerializeToString,
+                response_deserializer=utcp__pb2.ToolCallResponse.FromString,
+                _registered_method=True)
+
+
+class UTCPServiceServicer:
+    """Missing associated documentation comment in .proto file."""
+
+    def GetManual(self, request, context):
+        """Missing associated documentation comment in .proto file."""
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+    def CallTool(self, request, context):
+        """Missing associated documentation comment in .proto file."""
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+    def CallToolStream(self, request, context):
+        """Missing associated documentation comment in .proto file."""
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+
+def add_UTCPServiceServicer_to_server(servicer, server):
+    rpc_method_handlers = {
+            'GetManual': grpc.unary_unary_rpc_method_handler(
+                    servicer.GetManual,
+                    request_deserializer=utcp__pb2.Empty.FromString,
+                    response_serializer=utcp__pb2.Manual.SerializeToString,
+            ),
+            'CallTool': grpc.unary_unary_rpc_method_handler(
+                    servicer.CallTool,
+                    request_deserializer=utcp__pb2.ToolCallRequest.FromString,
+                    response_serializer=utcp__pb2.ToolCallResponse.SerializeToString,
+            ),
+            'CallToolStream': grpc.unary_stream_rpc_method_handler(
+                    servicer.CallToolStream,
+                    request_deserializer=utcp__pb2.ToolCallRequest.FromString,
+                    response_serializer=utcp__pb2.ToolCallResponse.SerializeToString,
+            ),
+    }
+    generic_handler = grpc.method_handlers_generic_handler(
+            'grpcpb.UTCPService', rpc_method_handlers)
+    server.add_generic_rpc_handlers((generic_handler,))
+    server.add_registered_method_handlers('grpcpb.UTCPService', rpc_method_handlers)
+
+
+ # This class is part of an EXPERIMENTAL API.
+class UTCPService:
+    """Missing associated documentation comment in .proto file."""
+
+    @staticmethod
+    def GetManual(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_unary(
+            request,
+            target,
+            '/grpcpb.UTCPService/GetManual',
+            utcp__pb2.Empty.SerializeToString,
+            utcp__pb2.Manual.FromString,
+            options,
+            channel_credentials,
+            insecure,
+            call_credentials,
+            compression,
+            wait_for_ready,
+            timeout,
+            metadata,
+            _registered_method=True)
+
+    @staticmethod
+    def CallTool(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_unary(
+            request,
+            target,
+            '/grpcpb.UTCPService/CallTool',
+            utcp__pb2.ToolCallRequest.SerializeToString,
+            utcp__pb2.ToolCallResponse.FromString,
+            options,
+            channel_credentials,
+            insecure,
+            call_credentials,
+            compression,
+            wait_for_ready,
+            timeout,
+            metadata,
+            _registered_method=True)
+
+    @staticmethod
+    def CallToolStream(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_stream(
+            request,
+            target,
+            '/grpcpb.UTCPService/CallToolStream',
+            utcp__pb2.ToolCallRequest.SerializeToString,
+            utcp__pb2.ToolCallResponse.FromString,
+            options,
+            channel_credentials,
+            insecure,
+            call_credentials,
+            compression,
+            wait_for_ready,
+            timeout,
+            metadata,
+            _registered_method=True)

data/examples/graphql.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "utcp"
+
+# Registration runs GraphQL introspection and turns root fields into UTCP tools.
+client = UTCP::Client.create(config: {
+  manual_call_templates: [{
+    name: "local_graph",
+    call_template_type: "graphql",
+    url: ENV.fetch("UTCP_GRAPHQL_URL", "http://localhost:8085/graphql")
+  }]
+})
+
+puts client.list_tools.map(&:name)
+puts client.call_tool("local_graph.hello", name: "Ruby").inspect

data/examples/grpc.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "rbconfig"
+
+begin
+  require "grpc"
+rescue LoadError => load_error
+  unless ENV["UTCP_RBENV_REEXEC"] == "1"
+    rbenv = [ENV["RBENV_BIN"], "/opt/homebrew/bin/rbenv", "/usr/local/bin/rbenv", "rbenv"]
+      .compact.find { |candidate| candidate == "rbenv" || File.executable?(candidate) }
+    begin
+      selected_ruby = IO.popen([rbenv, "which", "ruby"], err: File::NULL, &:read).to_s.strip
+      unless selected_ruby.empty? || File.expand_path(selected_ruby) == File.expand_path(RbConfig.ruby)
+        root = File.expand_path("..", __dir__)
+        exec({ "UTCP_RBENV_REEXEC" => "1" }, selected_ruby, "-I#{File.join(root, "lib")}", __FILE__, *ARGV)
+      end
+    rescue Errno::ENOENT
+      nil
+    end
+  end
+
+  warn "Unable to load grpc with #{RbConfig.ruby}: #{load_error.message}"
+  warn "Install it for the active Ruby with: gem install grpc"
+  exit 1
+end
+
+require "utcp"
+
+# Add `gem "grpc"` to the application. The server implements grpcpb.UTCPService
+# with GetManual, CallTool, and optionally CallToolStream.
+client = UTCP::Client.create(config: {
+  manual_call_templates: [{
+    name: "rpc",
+    call_template_type: "grpc",
+    host: ENV.fetch("UTCP_GRPC_HOST", "localhost"),
+    port: Integer(ENV.fetch("UTCP_GRPC_PORT", "50051")),
+    service_name: "grpcpb.UTCPService",
+    use_ssl: ENV["UTCP_GRPC_TLS"] == "1"
+  }]
+})
+
+puts client.call_tool("rpc.echo", message: "Hello over gRPC").inspect

data/examples/grpc_python.py

@@ -0,0 +1,52 @@
+#!/usr/bin/env python3
+"""Call the generated UTCP gRPC stub against the example server."""
+
+import json
+import os
+from pathlib import Path
+import sys
+
+ROOT = Path(__file__).resolve().parents[1]
+VENV_ROOT = ROOT / ".venv-grpc"
+VENV_PYTHON = VENV_ROOT / "bin" / "python"
+if VENV_PYTHON.exists() and Path(sys.prefix).resolve() != VENV_ROOT.resolve():
+    os.execv(str(VENV_PYTHON), [str(VENV_PYTHON), __file__, *sys.argv[1:]])
+
+try:
+    import grpc
+except ImportError as error:
+    raise SystemExit("Missing grpcio. Run: make grpc-python-setup") from error
+
+
+GENERATED_DIR = Path(__file__).resolve().parent / "generated"
+sys.path.insert(0, str(GENERATED_DIR))
+
+try:
+    import utcp_pb2
+    import utcp_pb2_grpc
+except (ImportError, RuntimeError) as error:
+    raise SystemExit(
+        "Missing or incompatible generated gRPC stubs. Run: make grpc-python-setup"
+    ) from error
+
+
+def main():
+    host = os.environ.get("UTCP_GRPC_HOST", "127.0.0.1")
+    port = int(os.environ.get("UTCP_GRPC_PORT", "50051"))
+    with grpc.insecure_channel(f"{host}:{port}") as channel:
+        stub = utcp_pb2_grpc.UTCPServiceStub(channel)
+        manual = stub.GetManual(utcp_pb2.Empty(), timeout=5)
+        print("tools:", ", ".join(tool.name for tool in manual.tools))
+
+        response = stub.CallTool(
+            utcp_pb2.ToolCallRequest(
+                tool="echo",
+                args_json=json.dumps({"message": "Hello from Python gRPC client"}),
+            ),
+            timeout=5,
+        )
+        print(json.loads(response.result_json))
+
+
+if __name__ == "__main__":
+    main()

data/examples/http.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "utcp"
+
+# GET /utcp must return a UTCP 1.1 manual. Tool URLs are taken from that manual.
+client = UTCP::Client.create(config: {
+  variables: { API_TOKEN: ENV.fetch("API_TOKEN", "development-token") },
+  manual_call_templates: [{
+    name: "rest",
+    call_template_type: "http",
+    url: ENV.fetch("UTCP_HTTP_MANUAL", "http://localhost:8080/utcp"),
+    http_method: "GET"
+  }]
+})
+
+puts client.list_tools.map(&:name)
+puts client.call_tool("rest.echo", body: { message: "Hello over HTTP" }).inspect

data/examples/mcp.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "utcp"
+require "rbconfig"
+
+# Works with stdio and Streamable HTTP MCP servers. Tools are named server.tool.
+server = if ENV["MCP_URL"]
+           { transport: "http", url: ENV.fetch("MCP_URL") }
+         else
+           {
+             transport: "stdio",
+             command: ENV.fetch("MCP_COMMAND", RbConfig.ruby),
+             args: ENV["MCP_COMMAND"] ? [] : [File.expand_path("servers/mcp_stdio_server.rb", __dir__)]
+           }
+         end
+
+client = UTCP::Client.create(config: {
+  manual_call_templates: [{
+    name: "mcp_bridge",
+    call_template_type: "mcp",
+    config: { mcpServers: { demo: server } },
+    register_resources_as_tools: true
+  }]
+})
+
+puts client.list_tools.map(&:name)
+puts client.call_tool("mcp_bridge.demo.echo", message: "Hello from MCP").inspect
+client.close

data/examples/servers/graphql_server.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "http_helpers"
+
+port = Integer(ENV.fetch("PORT", "8085"))
+
+ExampleHTTP.server(port) do |server|
+  server.mount_proc("/graphql") do |request, response|
+    payload = ExampleHTTP.request_json(request)
+    if payload["query"].to_s.include?("UTCPIntrospection")
+      ExampleHTTP.json(response, {
+        data: {
+          __schema: {
+            queryType: {
+              name: "Query",
+              fields: [{
+                name: "hello",
+                description: "Return a greeting",
+                args: [{
+                  name: "name",
+                  description: "Person to greet",
+                  defaultValue: nil,
+                  type: { kind: "NON_NULL", name: nil, ofType: { kind: "SCALAR", name: "String" } }
+                }],
+                type: { kind: "SCALAR", name: "String" }
+              }]
+            },
+            mutationType: nil,
+            subscriptionType: nil,
+            types: [{ kind: "SCALAR", name: "String", fields: nil, enumValues: nil }]
+          }
+        }
+      })
+    else
+      name = payload.dig("variables", "name") || "world"
+      ExampleHTTP.json(response, { data: { hello: "Hello, #{name}!" } })
+    end
+  end
+end

data/examples/servers/grpc_server.py

@@ -0,0 +1,97 @@
+#!/usr/bin/env python3
+"""Small UTCP gRPC server used by examples/grpc.rb."""
+
+from concurrent import futures
+import json
+import os
+from pathlib import Path
+import signal
+import sys
+
+ROOT = Path(__file__).resolve().parents[2]
+VENV_ROOT = ROOT / ".venv-grpc"
+VENV_PYTHON = VENV_ROOT / "bin" / "python"
+if VENV_PYTHON.exists() and Path(sys.prefix).resolve() != VENV_ROOT.resolve():
+    os.execv(str(VENV_PYTHON), [str(VENV_PYTHON), __file__, *sys.argv[1:]])
+
+try:
+    import grpc
+except ImportError as error:
+    raise SystemExit(
+        "Missing grpcio. Run: make grpc-python-setup"
+    ) from error
+
+GENERATED_DIR = ROOT / "examples" / "generated"
+sys.path.insert(0, str(GENERATED_DIR))
+
+try:
+    import utcp_pb2
+    import utcp_pb2_grpc
+except (ImportError, RuntimeError) as error:
+    raise SystemExit(
+        "Missing or incompatible generated gRPC stubs. Run: make grpc-python-setup"
+    ) from error
+
+
+class UTCPService(utcp_pb2_grpc.UTCPServiceServicer):
+    def GetManual(self, _request, _context):
+        return utcp_pb2.Manual(
+            version="1.0.0",
+            tools=[
+                utcp_pb2.Tool(
+                    name="echo",
+                    description="Echo a JSON message from the Python gRPC server",
+                )
+            ],
+        )
+
+    def CallTool(self, request, context):
+        tool_name = request.tool.rsplit(".", 1)[-1]
+        if tool_name != "echo":
+            context.abort(grpc.StatusCode.NOT_FOUND, f"unknown tool: {request.tool}")
+
+        try:
+            arguments = json.loads(request.args_json or "{}")
+        except json.JSONDecodeError as error:
+            context.abort(grpc.StatusCode.INVALID_ARGUMENT, f"invalid args_json: {error}")
+
+        if not isinstance(arguments, dict):
+            context.abort(grpc.StatusCode.INVALID_ARGUMENT, "args_json must contain an object")
+
+        value = arguments.get("message", arguments.get("msg"))
+        return utcp_pb2.ToolCallResponse(result_json=json.dumps({"echo": value}))
+
+    def CallToolStream(self, request, context):
+        yield self.CallTool(request, context)
+
+
+def main():
+    port = int(os.environ.get("PORT", "50051"))
+    address = f"127.0.0.1:{port}"
+    server = grpc.server(futures.ThreadPoolExecutor(max_workers=4))
+    utcp_pb2_grpc.add_UTCPServiceServicer_to_server(UTCPService(), server)
+    if server.add_insecure_port(address) == 0:
+        raise RuntimeError(f"unable to bind grpc://{address}")
+
+    server.start()
+    print(f"Listening on grpc://{address} (Python)", file=sys.stderr, flush=True)
+
+    stopping = False
+
+    def shutdown(_signal_number, _frame):
+        nonlocal stopping
+        if not stopping:
+            stopping = True
+            server.stop(grace=2)
+
+    signal.signal(signal.SIGINT, shutdown)
+    signal.signal(signal.SIGTERM, shutdown)
+
+    try:
+        server.wait_for_termination()
+    finally:
+        server.stop(grace=0)
+
+
+if __name__ == "__main__":
+    main()

data/examples/servers/grpc_server.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require "json"
+require "grpc"
+require "utcp"
+
+class RawProtobufMessage
+  attr_reader :bytes
+
+  def initialize(bytes = "".b)
+    @bytes = bytes.to_s.b
+  end
+
+  def self.encode(message)
+    message.bytes
+  end
+
+  def self.decode(bytes)
+    new(bytes)
+  end
+end
+
+class ExampleUTCPService
+  include GRPC::GenericService
+  self.marshal_class_method = :encode
+  self.unmarshal_class_method = :decode
+  self.service_name = "grpcpb.UTCPService"
+
+  rpc :GetManual, RawProtobufMessage, RawProtobufMessage
+  rpc :CallTool, RawProtobufMessage, RawProtobufMessage
+  rpc :CallToolStream, RawProtobufMessage, stream(RawProtobufMessage)
+end
+
+class ExampleUTCPServer < ExampleUTCPService
+  def get_manual(_request, _call)
+    tool = UTCP::ProtobufWire.string_field(1, "echo") +
+      UTCP::ProtobufWire.string_field(2, "Echo a JSON message")
+    RawProtobufMessage.new(
+      UTCP::ProtobufWire.string_field(1, "1.0.0") +
+      UTCP::ProtobufWire.string_field(2, tool)
+    )
+  end
+
+  def call_tool(request, _call)
+    fields = UTCP::ProtobufWire.fields(request.bytes)
+    args = JSON.parse(fields[2].first.to_s)
+    result = JSON.generate(echo: args["message"])
+    RawProtobufMessage.new(UTCP::ProtobufWire.string_field(1, result))
+  end
+
+  def call_tool_stream(request, call)
+    response = call_tool(request, call)
+    [response].each
+  end
+end
+
+port = Integer(ENV.fetch("PORT", "50051"))
+server = GRPC::RpcServer.new
+server.add_http2_port("127.0.0.1:#{port}", :this_port_is_insecure)
+server.handle(ExampleUTCPServer.new)
+warn "Listening on grpc://127.0.0.1:#{port}"
+server.run_till_terminated_or_interrupted(%w[INT TERM], 1)

data/examples/servers/http_helpers.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "json"
+require "webrick"
+
+module ExampleHTTP
+  module_function
+
+  def server(port)
+    instance = WEBrick::HTTPServer.new(
+      BindAddress: "127.0.0.1",
+      Port: port,
+      AccessLog: [],
+      Logger: WEBrick::Log.new($stderr, WEBrick::Log::WARN)
+    )
+    trap("INT") { instance.shutdown }
+    trap("TERM") { instance.shutdown }
+    yield instance
+    warn "Listening on http://127.0.0.1:#{port}"
+    instance.start
+  end
+
+  def json(response, value, status: 200)
+    response.status = status
+    response["Content-Type"] = "application/json"
+    response.body = JSON.generate(value)
+  end
+
+  def request_json(request)
+    request.body.to_s.empty? ? {} : JSON.parse(request.body)
+  rescue JSON::ParserError
+    {}
+  end
+end

data/examples/servers/http_server.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "http_helpers"
+
+port = Integer(ENV.fetch("PORT", "8080"))
+base = "http://localhost:#{port}"
+
+ExampleHTTP.server(port) do |server|
+  server.mount_proc("/utcp") do |_request, response|
+    ExampleHTTP.json(response, {
+      utcp_version: "1.1.0",
+      manual_version: "1.0.0",
+      tools: [{
+        name: "echo",
+        tool_call_template: {
+          call_template_type: "http",
+          url: "#{base}/echo",
+          http_method: "POST",
+          body_field: "body"
+        }
+      }]
+    })
+  end
+
+  server.mount_proc("/echo") do |request, response|
+    ExampleHTTP.json(response, ExampleHTTP.request_json(request))
+  end
+end