mcp-https-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c26e1b2c9e3afd25e1e1023fc7c4d8c66e9bd443c59b5dd362419b8ff8bd77c8
+  data.tar.gz: 3fd4a2d122d5773d14c0953c770f22049a71521be28ba1343fb9d7090b5e2110
+SHA512:
+  metadata.gz: c0ecef82b8839eed90038752ed06a0878764cbe768377f7fb1e30784fcebe416b0873398c61eefab91edda07a6cae2a7b6c71d39d3452ff2819225676d4a2f31
+  data.tar.gz: 621057e9339dd61d970bd69f1e97c34c7d96b19bd9280d21328d55b08cd83fd9b56cc22e4bafb4d2789863e6f7ef25562c43eaf626ede135b6c1ba2e42004fe8

data/GEMINI.md

@@ -0,0 +1,56 @@
+# Gemini Code Assistant Context
+
+This document provides context for the Gemini Code Assistant to understand the project and assist in development.
+
+## Project Overview
+
+This is a **Ruby based Model Context Protocol (MCP) server**. It is designed to expose tools (like `greet`) over HTTP (SSE) for integration with MCP clients (such as Claude Desktop or Gemini clients).
+
+## Key Technologies
+
+*   **Language:** Ruby
+*   **SDK:** `mcp` (Model Context Protocol SDK)
+    https://github.com/modelcontextprotocol/ruby-sdk
+
+## Project Structure
+
+*   `main.rb`: Main entry point (Ruby).
+*   `Makefile`: Development shortcuts (test, lint, clean).
+
+## Development Setup
+
+1.  **Install Dependencies:**
+    ```bash
+    bundle install
+    ```
+
+## Running the Server
+
+The server is configured to run using the `StreamableHTTPTransport` (SSE) on port 8080 (default).
+
+```bash
+bundle exec ruby main.rb
+```
+
+*Note: This MCP server listens for HTTP connections (SSE).*
+
+## Best Practices
+
+*   **Tool Definition:**
+    *   Define tools as classes inheriting from `MCP::Tool`.
+    *   Use `description` and `input_schema` to clearly define the tool's capabilities and parameters.
+    *   Implement the execution logic in the `self.call` class method.
+    *   Ensure strict typing in `input_schema` to allow the LLM to call the tool correctly.
+
+*   **Logging:**
+    *   Always log to `$stderr` to avoid interfering with protocol communication if `stdio` transport is ever used (though this project uses HTTP).
+    *   `LOGGER = Logger.new($stderr)` is the convention.
+
+*   **Testing:**
+    *   Unit test tools in isolation using `RSpec`.
+    *   Verify both the return structure (`MCP::Tool::Response`) and the content.
+
+## Ruby MCP Developer Resources
+
+*   **MCP Ruby SDK (GitHub):** [https://github.com/modelcontextprotocol/ruby-sdk](https://github.com/modelcontextprotocol/ruby-sdk)
+*   **Model Context Protocol Documentation:** [https://modelcontextprotocol.io/](https://modelcontextprotocol.io/)

data/README.md

@@ -0,0 +1,57 @@
+# MCP HTTP/SSE Ruby Server
+
+A simple Model Context Protocol (MCP) server implemented in Ruby using the `mcp` SDK, exposing tools over HTTP (SSE).
+
+## Features
+
+- **greet**: A simple tool that echoes back a message.
+
+## Setup
+
+1.  **Install Ruby**: Ensure you have Ruby 3.0+ installed.
+2.  **Install Dependencies**:
+    ```bash
+    bundle install
+    ```
+    or
+    ```bash
+    make install
+    ```
+
+## Running the Server
+
+To run the server locally via HTTP (SSE) on port 8080:
+
+```bash
+bundle exec ruby main.rb
+```
+or
+```bash
+make run
+```
+
+The server will be available at `http://localhost:8080`.
+
+## Testing
+
+Run tests with RSpec:
+
+```bash
+make test
+```
+
+## Linting
+
+Run RuboCop:
+
+```bash
+make lint
+```
+
+## Development
+
+Use the following `make` commands for common tasks:
+- `make all`: Install, test, and lint.
+- `make format`: Auto-format code with RuboCop.
+- `make clean`: Clean up dependencies and lockfiles.
+

data/bin/mcp-https-ruby

@@ -0,0 +1,55 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'mcp_https_ruby'
+
+# Set up logging to stderr
+LOGGER = Logger.new($stderr)
+LOGGER.formatter = proc do |severity, datetime, progname, msg|
+  "#{JSON.dump(
+    {
+      timestamp: datetime.iso8601,
+      severity: severity,
+      progname: progname,
+      message: msg
+    }
+  )}\n"
+end
+LOGGER.level = Logger::INFO
+
+# Configure MCP
+MCP.configure do |config|
+  config.protocol_version = '2024-11-05'
+end
+
+# Initialize MCP Server
+server = MCP::Server.new(
+  name: 'hello-world-server',
+  version: '1.0.0',
+  tools: [GreetTool]
+)
+
+# Create the Fixed Streamable HTTP transport
+transport = FixedStreamableHTTPTransport.new(server)
+server.transport = transport
+
+# Create the Rack application
+app = proc do |env|
+  request = Rack::Request.new(env)
+  response = transport.handle_request(request)
+  response
+end
+
+# Run the server using streaming HTTP transport
+begin
+  port = ENV.fetch('PORT', 8080).to_i
+  LOGGER.info "Starting MCP server: #{server.name} (v#{server.version}) on HTTP port #{port}"
+  Rackup::Handler.get('puma').run(app, Port: port, Host: '0.0.0.0', Silent: true)
+rescue Interrupt
+  LOGGER.info 'Shutting down MCP server...'
+  transport.close
+rescue StandardError => e
+  LOGGER.error "Server error: #{e.message}"
+  LOGGER.error e.backtrace.join("\n")
+  exit 1
+end

data/lib/mcp_https_ruby.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'mcp'
+require 'logger'
+require 'rack'
+require 'rackup'
+require 'json'
+require 'time'
+require 'puma'
+
+require_relative 'tools/greet_tool'
+require_relative 'transports/fixed_streamable_http_transport'

data/lib/tools/greet_tool.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'mcp'
+require 'logger'
+
+# Define the greet tool
+class GreetTool < MCP::Tool
+  tool_name 'greet'
+  description 'Get a greeting from a local server.'
+  input_schema(
+    type: 'object',
+    properties: {
+      message: {
+        type: 'string',
+        description: 'The message to repeat.'
+      }
+    },
+    required: ['message']
+  )
+
+  class << self
+    def call(message:)
+      logger.info "GreetTool called with message: #{message}"
+      MCP::Tool::Response.new(
+        [
+          {
+            type: 'text',
+            text: message
+          }
+        ]
+      )
+    end
+
+    private
+
+    def logger
+      @logger ||= defined?(LOGGER) ? LOGGER : Logger.new($stderr)
+    end
+  end
+end

data/lib/transports/fixed_streamable_http_transport.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'mcp'
+require 'json'
+
+# Custom transport to fix response format for SSE
+class FixedStreamableHTTPTransport < MCP::Server::Transports::StreamableHTTPTransport
+  private
+
+  def send_response_to_stream(stream, response, _session_id)
+    message = JSON.parse(response)
+    send_to_stream(stream, message)
+    [202, {}, []]
+  end
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: mcp-https-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gemini User
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mcp
+  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: puma
+  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: rack
+  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: rackup
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Exposes tools over HTTP (SSE) using the MCP SDK.
+email:
+- user@example.com
+executables:
+- mcp-https-ruby
+extensions: []
+extra_rdoc_files: []
+files:
+- GEMINI.md
+- README.md
+- bin/mcp-https-ruby
+- lib/mcp_https_ruby.rb
+- lib/tools/greet_tool.rb
+- lib/transports/fixed_streamable_http_transport.rb
+homepage: https://github.com/example/mcp-https-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/example/mcp-https-ruby
+  source_code_uri: https://github.com/example/mcp-https-ruby
+  changelog_uri: https://github.com/example/mcp-https-ruby/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: A simple Model Context Protocol (MCP) server implemented in Ruby.
+test_files: []