rails-pg-extras 5.6.10 → 6.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2207f16892a3e8d48f92833a2388f4e194b27b2e365f41f6461112510828c2d8
-  data.tar.gz: f4cde7b6f204d740f520b87b1c3cd04f40d199680adc103e7611fb18ba2caa29
+  metadata.gz: 0eb7080dab805a854ce746d67d42ea84e7b315587ea49a952ecafaaa9bc7a3b7
+  data.tar.gz: 82004fbeae8c56a47a52bf7ed3880af1c7408fb6a5fdf4fa8acfc91b9261d8e0
 SHA512:
-  metadata.gz: 0e0866a4c4a75e3a095c5956163143cc1d451099bfd6a6cd2620b2073439558dcd0510458bb358164b5cdd3f4d12a862cf251571f6885ffb044b93a98db1ef77
-  data.tar.gz: 3c6dc4a9f5e147c692c64160538ba95749eeb4f9abbb3998a73df7f05c4b8824487c31481ad84511c007a70fffe5f6fd187dde61dd0c57853981c3c8b9de066e
+  metadata.gz: 8648efd4fb3f4f53bae5aa397e8aba53341846c7f6af3597c3c1fe66ca4af7f2bd92117014449cb25295ce57b96dadc7defcd2d09e6eff41aa646bb95efb7ed9
+  data.tar.gz: 40261d23146c0d9dc0a0c09ca24b980bcc731e6b3199b20825a95208f14519935224d00a626995dea2b2039aaafe4ac671ed4e03acc485cf9d6700995a66f26a

data/.github/workflows/ci.yml

@@ -12,7 +12,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby-version: ['3.4', '3.3', '3.2', '3.1', '3.0', '2.7']
+        ruby-version: ['3.4', '3.3', '3.2', '3.1']
     steps:
       - uses: actions/checkout@v4
       - name: Run PostgreSQL 12

data/README.md

@@ -148,6 +148,43 @@ RailsPgExtras.configure do |config|
 end
 ```
 
+## MCP LLM integration
+
+Library supports MCP protocol via HTTP SSE interface. 
+
+`config/routes.rb`
+
+```ruby
+# Authentication is not yet supported
+mount RailsPgExtras.mcp_app, at: "pg-extras-mcp"
+```
+
+Install [mcp-remote](https://github.com/geelen/mcp-remote):
+
+```bash
+npm install -g mcp-remote
+```
+
+and in your LLM of choice:
+
+```json
+{
+  "mcpServers": {
+    "pg-extras": {
+      "command": "npx",
+      "args": [
+        "mcp-remote",
+        "http://localhost:3000/pg-extras-mcp/sse"
+      ]
+    }
+  }
+}
+```
+
+You can now ask LLM questions about the metadata and performance metrics of your database.
+
+![Web interface](https://github.com/pawurb/rails-pg-extras/raw/main/pg-extras-mcp.png)
+
 ## Available methods
 
 ### `measure_queries`

data/app/views/rails_pg_extras/web/queries/show.html.erb

@@ -3,10 +3,8 @@
 
 <br>
 
-<%=
-  link_to "← Back to Diagnose", queries_path,
-          class: "inline-block bg-blue-500 text-white font-medium px-4 py-2 rounded-lg shadow-md hover:bg-blue-600 transition"
-%>
+<%= link_to "← Back to Diagnose", queries_path,
+            class: "inline-block bg-blue-500 text-white font-medium px-4 py-2 rounded-lg shadow-md hover:bg-blue-600 transition" %>
 
 <% if @error %>
   <div class="text-red-500 p-3 font-mono my-5"><%= @error %></div>

data/app/views/rails_pg_extras/web/shared/_queries_selector.html.erb

@@ -1,7 +1,7 @@
-<%= form_tag queries_path, id: "queries", method: :get do |f| %>
-  <%= select_tag :query_name, options_for_select(@all_queries, params[:query_name]),
-                 { prompt: "diagnose", class: "border p-2 font-bold", autofocus: true } %>
-<% end %>
+<%= form_tag queries_path, id: "queries", method: :get do |f| %>
+  <%= select_tag :query_name, options_for_select(@all_queries, params[:query_name]),
+                 { prompt: "diagnose", class: "border p-2 font-bold", autofocus: true } %>
+<% end %>
 
 <%= javascript_tag nonce: true do -%>
   document.getElementById('queries').addEventListener('change', (e) => {

data/lib/rails-pg-extras.rb

@@ -10,6 +10,7 @@ require "rails_pg_extras/missing_fk_indexes"
 require "rails_pg_extras/missing_fk_constraints"
 require "rails_pg_extras/table_info"
 require "rails_pg_extras/table_info_print"
+require "rails_pg_extras/mcp_app"
 
 module RailsPgExtras
   QUERIES = RubyPgExtras::QUERIES
@@ -157,6 +158,10 @@ module RailsPgExtras
       ActiveRecord::Base.connection
     end
   end
+
+  def self.mcp_app
+    RailsPgExtras::MCPApp.build
+  end
 end
 
 require "rails_pg_extras/web"

data/lib/rails_pg_extras/mcp_app.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+# MCP Server Rake Tasks
+
+require "fast_mcp"
+require "rack"
+require "rails_pg_extras/version"
+
+SKIP_QUERIES = %i[
+  add_extensions
+  pg_stat_statements_reset
+  kill_pid
+  kill_all
+  mandelbrot
+]
+
+# Dynamically create tool classes for each query
+QUERY_TOOL_CLASSES = RubyPgExtras::QUERIES.reject { |q| SKIP_QUERIES.include?(q) }.map do |query_name|
+  Class.new(FastMcp::Tool) do
+    description RubyPgExtras.description_for(query_name: query_name)
+
+    define_method :call do
+      RailsPgExtras.public_send(query_name, in_format: :hash)
+    end
+
+    define_singleton_method :name do
+      query_name.to_s
+    end
+  end
+end
+
+# Additional specialized tool classes
+class MissingFkConstraintsTool < FastMcp::Tool
+  description "Shows missing foreign key constraints"
+
+  def call
+    RailsPgExtras.missing_fk_constraints(in_format: :hash)
+  end
+
+  def self.name
+    "missing_fk_constraints"
+  end
+end
+
+class MissingFkIndexesTool < FastMcp::Tool
+  description "Shows missing foreign key indexes"
+
+  def call
+    RailsPgExtras.missing_fk_indexes(in_format: :hash)
+  end
+
+  def self.name
+    "missing_fk_indexes"
+  end
+end
+
+class DiagnoseTool < FastMcp::Tool
+  description "Performs a health check of the database"
+
+  def call
+    RailsPgExtras.diagnose(in_format: :hash)
+  end
+
+  def self.name
+    "diagnose"
+  end
+end
+
+class ReadmeResource < FastMcp::Resource
+  uri "file://README.md"
+  resource_name "README"
+  description "The README for RailsPgExtras"
+  mime_type "text/plain"
+
+  def content
+    File.read(uri)
+  end
+end
+
+module RailsPgExtras
+  class MCPApp
+    def self.build
+      app = lambda do |_env|
+        [200, { "Content-Type" => "text/html" },
+         ["<html><body><h1>Hello from Rack!</h1><p>This is a simple Rack app with MCP middleware.</p></body></html>"]]
+      end
+
+      # Create the MCP middleware
+      mcp_app = FastMcp.rack_middleware(
+        app,
+        name: "rails-pg-extras", version: RailsPgExtras::VERSION,
+        path_prefix: "/pg-extras-mcp",
+        logger: Logger.new($stdout),
+      ) do |server|
+        server.register_tools(DiagnoseTool)
+        server.register_tools(MissingFkConstraintsTool)
+        server.register_tools(MissingFkIndexesTool)
+        server.register_tools(*QUERY_TOOL_CLASSES)
+
+        # Register a sample resource
+        server.register_resource(ReadmeResource)
+
+        Rack::Builder.new { run mcp_app }
+      end
+    end
+  end
+end

data/lib/rails_pg_extras/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsPgExtras
-  VERSION = "5.6.10"
+  VERSION = "6.0.1"
 end

data/rails-pg-extras.gemspec

@@ -17,6 +17,7 @@ Gem::Specification.new do |s|
   s.license = "MIT"
   s.add_dependency "ruby-pg-extras", RailsPgExtras::VERSION
   s.add_dependency "rails"
+  s.add_dependency "fast-mcp"
   s.add_development_dependency "rake"
   s.add_development_dependency "rspec"
   s.add_development_dependency "rufo"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-pg-extras
 version: !ruby/object:Gem::Version
-  version: 5.6.10
+  version: 6.0.1
 platform: ruby
 authors:
 - pawurb
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-07 00:00:00.000000000 Z
+date: 2025-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-pg-extras
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.6.10
+        version: 6.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.6.10
+        version: 6.0.1
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: fast-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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -116,6 +130,7 @@ files:
 - lib/rails_pg_extras/diagnose_print.rb
 - lib/rails_pg_extras/index_info.rb
 - lib/rails_pg_extras/index_info_print.rb
+- lib/rails_pg_extras/mcp_app.rb
 - lib/rails_pg_extras/missing_fk_constraints.rb
 - lib/rails_pg_extras/missing_fk_indexes.rb
 - lib/rails_pg_extras/railtie.rb
@@ -126,6 +141,7 @@ files:
 - lib/rails_pg_extras/web.rb
 - lib/rails_pg_extras/web/engine.rb
 - marginalia-logs.png
+- pg-extras-mcp.png
 - pg-extras-ui-3.png
 - rails-pg-extras-diagnose.png
 - rails-pg-extras.gemspec