swagger_mcp_tool 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9eccf6efe7428d34e07a2862835e55b8d76ec3941d092c2b2db88ee0f504836
-  data.tar.gz: 18afd57f6908aed1bbd99a34ee955aaf87d8ab3098d5b2ceb1228d17b99591d3
+  metadata.gz: 9a7c9a8135edeb2cc144723ca07ee9723179d99b542e47ad2319793434dd8ed8
+  data.tar.gz: e651d04bc9a2211aeeb93f6dd5e19b505097173d793feb56f63d8cf14fce245c
 SHA512:
-  metadata.gz: 2b9200c4656ed3db2db9979796836f462a40a91888139e6d8f996299b27d2a98d5d6808c85e6286d19a74a0e48b00166cb8ce1ec33804e868339ce6737e157bb
-  data.tar.gz: f1e5978ec5ee724f567d29c7569580eb4a16316b995847c731e6b5cdf746e21410631851f712425e6a943781143d34741f75c7f6723eea35053e7dee32647852
+  metadata.gz: 1f941db14c926b9f36c6e3dda7ecff8e925ca70bf1886ed0e5e09babe1642afb98fa578da306fa29a2ae57cea906834f6edc6fd8516a1c9ba89fdcd1cc220517
+  data.tar.gz: ac9c8534744bd32efbd5f62e5ba4d9ee23ae60f40f81339a3bf48492129cab789eaac626bbc78551f89b6f2929da18f8f35fe5a14fff063e1e2e0cafa2012f00

data/README.md

@@ -21,10 +21,10 @@ A Ruby gem that automatically generates MCP (Model Context Protocol) tools from
 - Gems:
   - sinatra
   - sinatra-contrib  
-  - mcp (~> 0.1.0)
+  - mcp
   - json
   - puma
-  - rackup (~> 2.2)
+  - rackup
   - pry (development)
   - rake (development)
 
@@ -85,10 +85,38 @@ swagger_mcp_server --help
 
 ### STDIO Server (Recommended for MCP Integration)
 
-Use the provided example for direct integration with MCP clients like Vscode IDE:
+Use the provided example for direct integration with MCP clients like Kiro IDE:
 
 **File: `examples/mcp_stdio_server.rb`**
 
+
+```ruby
+
+require 'swagger_mcp_tool'
+
+SwaggerMCPTool.configure do |config|
+  # Swagger settings
+  config.swagger_url = 'https://petstore.swagger.io/v2/swagger.json'
+
+  # MCP settings
+  config.mcp_name = 'my_company_api'
+  config.mcp_name_for_human = 'My Company API'
+  config.mcp_description_for_human = "Tools for interacting with My Company's API"
+  config.auth_header_name = :'Token'
+  config.protocol_version = "2025-03-26"
+
+  # Force stdio mode
+  config.stdio_mode = true if config.respond_to?(:stdio_mode=)
+end
+
+# Start the MCP server in stdio mode
+SwaggerMCPTool.start_stdio_server
+
+```
+
+### OR
+
+
 ```ruby
 #!/usr/bin/env ruby
 
@@ -227,6 +255,7 @@ Use the provided example for HTTP-based integration:
 
 gem install swagger_mcp_tool
 
+
 require 'swagger_mcp_tool'
 SwaggerMCPTool.configure do |config|
   # Server settings
@@ -240,7 +269,7 @@ SwaggerMCPTool.configure do |config|
   config.mcp_name = 'my_company_api'
   config.mcp_name_for_human = 'My Company API'
   config.mcp_description_for_human = "Tools for interacting with My Company's API"
-  config.auth_header_name = :'Token'
+  config.auth_header_name = :'X-Auth-Token'
 end
 
 # Start the server
@@ -297,6 +326,7 @@ end
 | `mcp_name` | 'swagger_api_tools' | MCP server name |
 | `auth_type` | 'none' | Authentication type |
 | `auth_header_name` | 'Token' | Auth header name |
+| `protocol_version` | '2025-03-26' | Protocol Version Supported by Client |
 
 ## Working with Prompts
 
@@ -324,9 +354,9 @@ end
 
 ## MCP Integration
 
-### Vscode IDE Integration
+### Kiro IDE Integration
 
-To use with Vscode IDE, add the server to your MCP configuration file (`.vscode/settings/mcp.json`):
+To use with Kiro IDE, add the server to your MCP configuration file (`.kiro/settings/mcp.json`):
 
 ```json
 {
@@ -334,11 +364,11 @@ To use with Vscode IDE, add the server to your MCP configuration file (`.vscode/
     "swagger-mcp-tool": {
       "command": "/Users/<user>/.rbenv/versions/3.2.2/bin/ruby",
       "args": [
-        "/Users/<user>/swagger_mcp_tool/examples/mcp_stdio_server.rb"
+        "/Users/<user>/projects/dummy/swagger_mcp_tool/examples/mcp_stdio_server.rb"
       ],
       "env": {
         "RBENV_VERSION": "3.2.2",
-        "PATH": "/Users/<user>/.rbenv/versions/3.2.2/bin:/Users/aki/.rbenv/shims:/usr/local/bin:/usr/bin:/bin"
+        "PATH": "/Users/<user>/.rbenv/versions/3.2.2/bin:/Users/<user>/.rbenv/shims:/usr/local/bin:/usr/bin:/bin"
       },
       "disabled": false,
       "autoApprove": []
@@ -372,6 +402,16 @@ The server automatically generates MCP tools based on your Swagger specification
 
 ## Authentication
 
+### Setting an Auth Token (HTTP Server)
+
+You can set an auth token for a user by making a POST request to the `/set_auth_token` endpoint:
+
+```bash
+curl -X POST http://localhost:3001/set_auth_token \
+  -H "Content-Type: application/json" \
+  -d '{"user_id": "user123", "auth_token": "Bearer token123"}'
+```
+
 ### Passing User Context (HTTP Server)
 
 When making requests to the HTTP MCP server, you can pass user context in the headers:
@@ -382,7 +422,7 @@ curl -X POST http://localhost:3001/mcp \
   -H "X-User-ID: user123" \
   -H "X-Username: John Doe" \
   -H "X-Email: john@example.com" \
-  -H "Auth-Token: Bearer token123" \
+  -H "X-Auth-Token: Bearer token123" \
   -d '{"jsonrpc":"2.0","id":"1","method":"tools/list"}'
 ```
 
@@ -423,9 +463,9 @@ When running the HTTP server, the following endpoints are available:
 
 ## Testing Your Tools
 
-### With Vscode IDE
+### With Kiro IDE
 
-Once configured in Vscode, you can test tools directly:
+Once configured in Kiro, you can test tools directly:
 
 ```
 # Test getInventory (no parameters)
@@ -512,7 +552,7 @@ end
 
 - **STDIO Server**: Logs go to stderr, check your terminal output
 - **HTTP Server**: Logs go to the configured log file (default: `mcp_server.log`)
-- **Vscode Integration**: Check Vscode's MCP server logs in the IDE
+- **Kiro Integration**: Check Kiro's MCP server logs in the IDE
 
 ### Verifying Tool Generation
 
@@ -582,8 +622,6 @@ The gem consists of several key components:
 
 After checking out the repo, run `bundle install` to install dependencies.
 
-After checking out the repo, run `bundle install` to install dependencies.
-
 To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing

data/lib/swagger_mcp_tool/config.rb

@@ -2,7 +2,6 @@
 
 require 'logger'
 require 'singleton'
-
 module SwaggerMCPTool
   # Configuration management for SwaggerMCPTool
   #
@@ -15,7 +14,8 @@ module SwaggerMCPTool
                   :log_level, :log_file, :swagger_url, :mcp_name,
                   :mcp_name_for_human, :mcp_description_for_human,
                   :mcp_description_for_model, :auth_type, :default_token,
-                  :prompts, :resources, :auth_header_name, :tools
+                  :prompts, :resources, :auth_header_name, :tools, :protocol_version,
+                  :exclude_tools
 
     DEFAULT_SERVER_PORT = 3001
     DEFAULT_SERVER_BIND = '0.0.0.0'
@@ -29,6 +29,7 @@ module SwaggerMCPTool
     DEFAULT_MCP_DESCRIPTION_FOR_MODEL = 'This MCP server provides tools for interacting with APIs via Swagger/OpenAPI specifications.'
     DEFAULT_AUTH_TYPE = 'none'
     DEFAULT_LOG_FILE = nil
+    DEFAULT_PROTOCOL_VERSION = "2024-11-05"
 
     def initialize
       # Server settings
@@ -47,6 +48,7 @@ module SwaggerMCPTool
       @tools = []
       @resources = []
       @prompts = [] # Will be generated lazily
+      @exclude_tools = []
     end
 
     def setup_server_defaults
@@ -67,6 +69,7 @@ module SwaggerMCPTool
       @mcp_name_for_human = DEFAULT_MCP_NAME_FOR_HUMAN
       @mcp_description_for_human = DEFAULT_MCP_DESCRIPTION_FOR_HUMAN
       @mcp_description_for_model = DEFAULT_MCP_DESCRIPTION_FOR_MODEL
+      @protocol_version = DEFAULT_PROTOCOL_VERSION
     end
 
     def setup_auth_defaults

data/lib/swagger_mcp_tool/helpers/request.rb

@@ -19,7 +19,7 @@ module SwaggerMCPTool
       end
 
       def create_http_request(method, uri, params)
-        req_method = request_methods(method.downcase)
+        req_method = request_methods(method.downcase&.to_sym)
         request = req_method.new(uri.request_uri)
 
         set_json_body(request, params) if body_required?(method.downcase)
@@ -58,7 +58,10 @@ module SwaggerMCPTool
 
       def add_headers_to_request(request, headers, auth_token)
         # Add custom headers
-        headers.each { |key, value| request[key] = value }
+        headers.each do |key, value|
+          next unless valid_header?(key, value)
+          request[key] = sanitize_header_value(value)
+        end
 
         # Add authorization header if available
         add_authorization_header(request, auth_token)
@@ -109,6 +112,11 @@ module SwaggerMCPTool
       def filter_unused_params(params, used_params)
         params.reject { |key, _| used_params.include?(key) }
       end
+
+      def sanitize_header_value(value)
+        # Remove any potentially dangerous characters
+        value.to_s.gsub(/[\r\n\0]/, '')
+      end
     end
   end
 end

data/lib/swagger_mcp_tool/helpers/tool_register.rb

@@ -2,6 +2,20 @@
 
 module SwaggerMCPTool
   module Helpers
+    # Provides helper methods for registering and initializing tools using Swagger definitions.
+    # This module includes methods to set up the tool registry, generate tools from a Swagger URL,
+    # and handle dynamic tool registration. It is intended to be included in classes that require
+    # integration with the SwaggerMCPTool tool registry system.
+    #
+    # Example usage:
+    #   include SwaggerMCPTool::Helpers::ToolRegister
+    #
+    # @see SwaggerMCPTool::ToolRegistry
+    # @see SwaggerClient
+    # @see ToolGenerator
+    #
+    # @author Your Name
+    # @since 1.0.0
     module ToolRegister
       def tool_registry
         SwaggerMCPTool::ToolRegistry.instance

data/lib/swagger_mcp_tool/server.rb

@@ -5,7 +5,6 @@ require 'sinatra/json'
 require 'mcp'
 require 'json'
 require 'logger'
-require 'byebug'
 require_relative 'tool_registry'
 require_relative 'logging'
 require_relative 'config'
@@ -103,7 +102,7 @@ module SwaggerMCPTool
       self.class.before do
         headers 'Access-Control-Allow-Origin' => '*',
                 'Access-Control-Allow-Methods' => 'GET, POST, OPTIONS',
-                'Access-Control-Allow-Headers' => 'Content-Type, Authorization, X-User-ID, Auth-Token, X-Username, X-Email'
+                'Access-Control-Allow-Headers' => 'Content-Type, Authorization, X-User-ID, X-Auth-Token, X-Username, X-Email'
       end
     end
 
@@ -111,7 +110,7 @@ module SwaggerMCPTool
       self.class.options '*' do
         response.headers['Allow'] = 'GET, POST, OPTIONS'
         response.headers['Access-Control-Allow-Headers'] =
-          'Authorization, Content-Type, Accept, X-User-ID, Auth-Token, X-Username, X-Email'
+          'Authorization, Content-Type, Accept, X-User-ID, X-Auth-Token, X-Username, X-Email'
         200
       end
     end

data/lib/swagger_mcp_tool/stdio_server.rb

@@ -0,0 +1,53 @@
+require 'mcp'
+require 'mcp/server/transports/stdio_transport'
+require 'json'
+require 'logger'
+require_relative 'tool_registry'
+require_relative 'logging'
+require_relative 'config'
+require_relative 'helpers/tool_register'
+
+module SwaggerMCPTool
+  # This module provides the StdioServer for handling MCP tool operations via standard IO.
+  # StdioServer handles MCP tool operations via standard IO.
+  # It initializes the server, sets up configuration and logging,
+  # registers available tools, and starts the server using standard IO transport.
+  #
+  # @example
+  #   server = SwaggerMCPTool::StdioServer.new
+  #   server.start_stdio_server
+  #
+  # @see SwaggerMCPTool::Logging
+  # @see SwaggerMCPTool::Helpers::ToolRegister
+  # @see MCP::Server
+  # @see MCP::Server::Transports::StdioTransport
+  class StdioServer
+    include SwaggerMCPTool::Logging
+    include SwaggerMCPTool::Helpers::ToolRegister
+
+    def initialize
+      @config = Config.instance
+      @logger = @config.logger || Logger.new($stdout)
+      log_server_initialization
+      setup_tool_registry
+      initialize_tools
+    end
+
+    def start_stdio_server(context = {})
+      user_details = context
+      configuration = MCP::Configuration.new(protocol_version: @config.protocol_version)
+
+      # Create MCP server with our tools and prompts
+      mcp = MCP::Server.new(
+        name: @config.mcp_name,
+        tools: tool_registry.dynamic_tools,
+        prompts: @config.prompts,
+        server_context: user_details,
+        configuration: configuration
+      )
+
+      transport = MCP::Server::Transports::StdioTransport.new(mcp)
+      transport.open
+    end
+  end
+end

data/lib/swagger_mcp_tool/tool_registry.rb

@@ -25,9 +25,12 @@ module SwaggerMCPTool
       @dynamic_tools = @config.tools if @config&.tools
       validate_inputs!(tools, base_url)
       @logger.info "Registering #{tools.size} dynamic tools"
-
+      excluded_tools = Set.new(@config.exclude_tools)
+ 
       tools.each do |tool_def|
-        register_tool(tool_def, base_url) unless tool_exists?(tool_def['name'])
+        unless excluded_tools.include?(tool_def['name'])
+          register_tool(tool_def, base_url) unless tool_exists?(tool_def['name'])
+        end
       end
 
       @logger.info "Successfully registered #{@dynamic_tools.size} tools"

data/lib/swagger_mcp_tool/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SwaggerMcpTool
-  VERSION = '0.1.2'
+  VERSION = '0.1.4'
 end

data/lib/swagger_mcp_tool.rb

@@ -5,7 +5,11 @@ require 'swagger_mcp_tool/swagger_client'
 require 'swagger_mcp_tool/tool_generator'
 require 'swagger_mcp_tool/api_client'
 require 'swagger_mcp_tool/auth_handler'
+require 'swagger_mcp_tool/stdio_server'
 
+# The SwaggerMCPTool module provides functionality to start and configure a server,
+# as well as to run a stdio-based server for integration with other tools.
+# It defines custom error handling and exposes methods for server lifecycle management.
 module SwaggerMCPTool
   class Error < StandardError; end
 
@@ -18,4 +22,9 @@ module SwaggerMCPTool
   def self.configure(&block)
     Config.configure(&block)
   end
+
+  def self.start_stdio_server(context={})
+    server = StdioServer.new
+    server.start_stdio_server(context)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagger_mcp_tool
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Ankit
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-08-19 00:00:00.000000000 Z
+date: 2025-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -34,16 +34,16 @@ dependencies:
   name: mcp
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: puma
   requirement: !ruby/object:Gem::Requirement
@@ -152,20 +152,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.13.1
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
 description: A Model Context Protocol (MCP) server that generates tools from Swagger/OpenAPI
   specifications
 email:
@@ -191,6 +177,7 @@ files:
 - lib/swagger_mcp_tool/helpers/tool_register.rb
 - lib/swagger_mcp_tool/logging.rb
 - lib/swagger_mcp_tool/server.rb
+- lib/swagger_mcp_tool/stdio_server.rb
 - lib/swagger_mcp_tool/swagger_client.rb
 - lib/swagger_mcp_tool/tool_generator.rb
 - lib/swagger_mcp_tool/tool_registry.rb
@@ -207,7 +194,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.2
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="