mcp-inspector 0.1.0

data/lib/mcp_inspector/transport/base_adapter.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module MCPInspector
+  module Transport
+    class BaseAdapter
+      class ConnectionError < Error; end
+      class OperationError < Error; end
+      class TimeoutError < Error; end
+
+      def initialize(timeout: 30)
+        @timeout = timeout
+        @connected = false
+      end
+
+      def connect(server_config)
+        raise NotImplementedError, "Subclasses must implement #connect"
+      end
+
+      def disconnect
+        raise NotImplementedError, "Subclasses must implement #disconnect"
+      end
+
+      def connected?
+        @connected
+      end
+
+      def list_tools
+        ensure_connected!
+        raise NotImplementedError, "Subclasses must implement #list_tools"
+      end
+
+      def list_resources
+        ensure_connected!
+        raise NotImplementedError, "Subclasses must implement #list_resources"
+      end
+
+      def list_prompts
+        ensure_connected!
+        raise NotImplementedError, "Subclasses must implement #list_prompts"
+      end
+
+      def execute_tool(name, arguments = {})
+        ensure_connected!
+        raise NotImplementedError, "Subclasses must implement #execute_tool"
+      end
+
+      def read_resource(uri)
+        ensure_connected!
+        raise NotImplementedError, "Subclasses must implement #read_resource"
+      end
+
+      def get_prompt(name, arguments = {})
+        ensure_connected!
+        raise NotImplementedError, "Subclasses must implement #get_prompt"
+      end
+
+      def server_info
+        ensure_connected!
+        raise NotImplementedError, "Subclasses must implement #server_info"
+      end
+
+      private
+
+      attr_reader :timeout
+
+      def ensure_connected!
+        raise ConnectionError, "Not connected to server" unless connected?
+      end
+
+      def with_timeout
+        if timeout
+          Timeout.timeout(timeout) { yield }
+        else
+          yield
+        end
+      rescue Timeout::Error
+        raise TimeoutError, "Operation timed out after #{timeout} seconds"
+      end
+    end
+  end
+end

data/lib/mcp_inspector/transport/client_adapter.rb

@@ -0,0 +1,207 @@
+# frozen_string_literal: true
+require "mcp_client"
+
+module MCPInspector
+  module Transport
+    class ClientAdapter < BaseAdapter
+      def initialize(timeout: 30)
+        super
+        @client = nil
+        @server_config = nil
+      end
+
+      def connect(server_config)
+        @server_config = server_config
+        
+        begin
+          with_timeout do
+            case server_config.transport
+            when "stdio"
+              connect_stdio
+            when "sse"
+              connect_sse
+            when "websocket"
+              connect_websocket
+            else
+              raise ConnectionError, "Unsupported transport: #{server_config.transport}"
+            end
+          end
+          @connected = true
+        rescue => e
+          @connected = false
+          raise ConnectionError, "Failed to connect to #{server_config.name}: #{e.message}"
+        end
+      end
+
+      def disconnect
+        if @client && @client.respond_to?(:disconnect)
+          @client.disconnect
+        end
+        @client = nil
+        @connected = false
+      end
+
+      def list_tools
+        with_timeout do
+          response = @client.list_tools
+          normalize_response(response)
+        end
+      rescue => e
+        raise OperationError, "Failed to list tools: #{e.message}"
+      end
+
+      def list_resources
+        if @client.respond_to?(:list_resources)
+          with_timeout do
+            response = @client.list_resources
+            normalize_response(response)
+          end
+        else
+          []
+        end
+      rescue => e
+        raise OperationError, "Failed to list resources: #{e.message}"
+      end
+
+      def list_prompts
+        if @client.respond_to?(:list_prompts)
+          with_timeout do
+            response = @client.list_prompts
+            normalize_response(response)
+          end
+        else
+          # Return empty prompts list if not supported
+          []
+        end
+      rescue => e
+        raise OperationError, "Failed to list prompts: #{e.message}"
+      end
+
+      def execute_tool(name, arguments = {})
+        with_timeout do
+          response = @client.call_tool(name, arguments)
+          normalize_response(response)
+        end
+      rescue => e
+        raise OperationError, "Failed to execute tool '#{name}': #{e.message}"
+      end
+
+      def read_resource(uri)
+        if @client.respond_to?(:read_resource)
+          with_timeout do
+            response = @client.read_resource(uri)
+            normalize_response(response)
+          end
+        else
+          raise OperationError, "Resource reading is not supported by this server"
+        end
+      rescue => e
+        raise OperationError, "Failed to read resource '#{uri}': #{e.message}"
+      end
+
+      def get_prompt(name, arguments = {})
+        if @client.respond_to?(:get_prompt)
+          with_timeout do
+            response = @client.get_prompt(name, arguments)
+            normalize_response(response)
+          end
+        else
+          raise OperationError, "Prompts are not supported by this server"
+        end
+      rescue => e
+        raise OperationError, "Failed to get prompt '#{name}': #{e.message}"
+      end
+
+      def server_info
+        {
+          name: @server_config.name,
+          transport: @server_config.transport,
+          connected: connected?,
+          capabilities: detect_capabilities
+        }
+      end
+
+      private
+
+      def connect_stdio
+        @client = MCPClient::ServerStdio.new(
+          command: @server_config.command.join(' '),
+          env: @server_config.env
+        )
+        @client.connect
+      end
+
+      def connect_sse
+        @client = MCPClient::ServerSSE.new(url: @server_config.url)
+        @client.connect
+      end
+
+      def connect_websocket
+        @client = MCPClient::ServerHTTP.new(url: @server_config.url)
+        @client.connect
+      end
+
+      def normalize_response(response)
+        case response
+        when Hash
+          response
+        when Array
+          # Handle arrays of MCPClient objects
+          if response.first.respond_to?(:name) && response.first.respond_to?(:description)
+            # Array of Tool, Resource, or Prompt objects
+            response.map { |item| normalize_mcp_object(item) }
+          else
+            response
+          end
+        else
+          response
+        end
+      end
+
+      def normalize_mcp_object(obj)
+        base_data = {
+          name: obj.name,
+          description: obj.description
+        }
+        
+        # Add schema for tools
+        if obj.respond_to?(:schema) && obj.schema
+          base_data[:inputSchema] = obj.schema
+        end
+        
+        # Add other properties that might exist
+        base_data[:uri] = obj.uri if obj.respond_to?(:uri)
+        base_data[:mimeType] = obj.mimeType if obj.respond_to?(:mimeType)
+        
+        base_data
+      end
+
+      def detect_capabilities
+        capabilities = []
+        
+        begin
+          list_tools
+          capabilities << "tools"
+        rescue OperationError
+          # Tools not supported
+        end
+
+        begin
+          list_resources
+          capabilities << "resources"
+        rescue OperationError
+          # Resources not supported
+        end
+
+        begin
+          list_prompts
+          capabilities << "prompts"
+        rescue OperationError
+          # Prompts not supported
+        end
+
+        capabilities
+      end
+    end
+  end
+end

data/lib/mcp_inspector/transport/server_config.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+require "json"
+
+module MCPInspector
+  module Transport
+    class ServerConfig
+      class ValidationError < Error; end
+
+      REQUIRED_FIELDS = %w[name transport].freeze
+      STDIO_REQUIRED_FIELDS = %w[command].freeze
+      URL_REQUIRED_FIELDS = %w[url].freeze
+      VALID_TRANSPORTS = %w[stdio sse websocket].freeze
+
+      attr_reader :name, :transport, :command, :args, :env, :working_directory, :url
+
+      def initialize(config_hash)
+        @raw_config = config_hash
+        validate_and_parse_config!
+      end
+
+      def self.from_json(json_string)
+        config_hash = JSON.parse(json_string)
+        new(config_hash)
+      rescue JSON::ParserError => e
+        raise ValidationError, "Invalid JSON: #{e.message}"
+      end
+
+      def stdio?
+        transport == "stdio"
+      end
+
+      def sse?
+        transport == "sse"
+      end
+
+      def websocket?
+        transport == "websocket"
+      end
+
+      def to_h
+        {
+          name: name,
+          transport: transport,
+          command: command,
+          args: args,
+          env: env,
+          working_directory: working_directory,
+          url: url
+        }.compact
+      end
+
+      def to_json(*args)
+        to_h.to_json(*args)
+      end
+
+      private
+
+      attr_reader :raw_config
+
+      def validate_and_parse_config!
+        validate_required_fields!
+        validate_transport!
+        validate_transport_specific_fields!
+        parse_fields!
+      end
+
+      def validate_required_fields!
+        missing_fields = REQUIRED_FIELDS - raw_config.keys
+        return if missing_fields.empty?
+
+        raise ValidationError, "Missing required fields: #{missing_fields.join(', ')}"
+      end
+
+      def validate_transport!
+        unless VALID_TRANSPORTS.include?(raw_config["transport"])
+          raise ValidationError, "Invalid transport '#{raw_config['transport']}'. Valid options: #{VALID_TRANSPORTS.join(', ')}"
+        end
+      end
+
+      def validate_transport_specific_fields!
+        case raw_config["transport"]
+        when "stdio"
+          validate_stdio_fields!
+        when "sse", "websocket"
+          validate_url_fields!
+        end
+      end
+
+      def validate_stdio_fields!
+        missing_fields = STDIO_REQUIRED_FIELDS - raw_config.keys
+        return if missing_fields.empty?
+
+        raise ValidationError, "Missing required fields for stdio transport: #{missing_fields.join(', ')}"
+      end
+
+      def validate_url_fields!
+        missing_fields = URL_REQUIRED_FIELDS - raw_config.keys
+        return if missing_fields.empty?
+
+        raise ValidationError, "Missing required fields for URL-based transport: #{missing_fields.join(', ')}"
+      end
+
+      def parse_fields!
+        @name = raw_config["name"]
+        @transport = raw_config["transport"]
+        @command = parse_command(raw_config["command"]) if raw_config["command"]
+        @args = raw_config["args"] || []
+        @env = parse_env(raw_config["env"] || {})
+        @working_directory = raw_config["working_directory"] || "."
+        @url = raw_config["url"] if raw_config["url"]
+      end
+
+      def parse_command(command)
+        case command
+        when Array
+          command
+        when String
+          command.split
+        else
+          raise ValidationError, "Command must be a string or array of strings"
+        end
+      end
+
+      def parse_env(env_hash)
+        return {} unless env_hash.is_a?(Hash)
+
+        env_hash.transform_values { |value| expand_env_variable(value) }
+      end
+
+      def expand_env_variable(value)
+        return value unless value.is_a?(String)
+
+        value.gsub(/\$\{([^}]+)\}/) do |match|
+          env_var = ::Regexp.last_match(1)
+          ENV[env_var] || match
+        end
+      end
+    end
+  end
+end

data/lib/mcp_inspector/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MCPInspector
+  VERSION = "0.1.0"
+end

data/lib/mcp_inspector.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "zeitwerk"
+require "timeout"
+
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+
+module MCPInspector
+  class Error < StandardError; end
+end
+
+# Eagerly load CLI so it's available for the executable
+require_relative "mcp_inspector/cli"

data/sig/mcp/inspector.rbs

@@ -0,0 +1,6 @@
+module Mcp
+  module Inspector
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: mcp-inspector
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Enrique Mogollan
+bindir: exe
+cert_chain: []
+date: 2025-08-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: ruby-mcp-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+description: A Ruby gem that provides tooling for connecting to and inspecting MCP
+  servers, allowing you to list and execute tools, resources, and prompts with JSON
+  output.
+email:
+- emogollan@gmail.com
+executables:
+- mcp-inspector
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- README.md
+- Rakefile
+- examples/mcp-inspector.json
+- exe/mcp-inspector
+- lib/mcp_inspector.rb
+- lib/mcp_inspector/cli.rb
+- lib/mcp_inspector/data/config_manager.rb
+- lib/mcp_inspector/data/input_adapter.rb
+- lib/mcp_inspector/data/output_adapter.rb
+- lib/mcp_inspector/presentation/base_formatter.rb
+- lib/mcp_inspector/presentation/json_formatter.rb
+- lib/mcp_inspector/transport/base_adapter.rb
+- lib/mcp_inspector/transport/client_adapter.rb
+- lib/mcp_inspector/transport/server_config.rb
+- lib/mcp_inspector/version.rb
+- sig/mcp/inspector.rbs
+homepage: https://github.com/mogox/mcp-inspector
+licenses: []
+metadata:
+  homepage_uri: https://github.com/mogox/mcp-inspector
+  source_code_uri: https://github.com/mogox/mcp-inspector
+  bug_tracker_uri: https://github.com/mogox/mcp-inspector/issues
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.6
+specification_version: 4
+summary: A tool for inspecting MCP (Model Context Protocol) servers
+test_files: []