rails-pg-extras 5.6.10 → 5.6.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2207f16892a3e8d48f92833a2388f4e194b27b2e365f41f6461112510828c2d8
-  data.tar.gz: f4cde7b6f204d740f520b87b1c3cd04f40d199680adc103e7611fb18ba2caa29
+  metadata.gz: 0ab5f408e9c0a7f70fea16a4d8d2e5079b130c8bb3536a2da760aa8cc509b1cf
+  data.tar.gz: 39a83a3ce09da9710884277245c2306ab70b3584f32885651f4553a7faf0ebbb
 SHA512:
-  metadata.gz: 0e0866a4c4a75e3a095c5956163143cc1d451099bfd6a6cd2620b2073439558dcd0510458bb358164b5cdd3f4d12a862cf251571f6885ffb044b93a98db1ef77
-  data.tar.gz: 3c6dc4a9f5e147c692c64160538ba95749eeb4f9abbb3998a73df7f05c4b8824487c31481ad84511c007a70fffe5f6fd187dde61dd0c57853981c3c8b9de066e
+  metadata.gz: 23302e3cf2afab6463cf306dc9d7274d0da0364080e105559260b47f93ec3c55bfb7faed12185f7119a6b4a64fb64568ce637e03a8cef4188fe983039753218d
+  data.tar.gz: 00bf2ca5b4c857ba53063f3063501d5d2d4a5b561256aef79de379b921461d041e5e50bf4667480d06a2aafad986c8c95b2437ca0cd0f87b457f62e6388104e2

data/README.md

@@ -12,6 +12,10 @@ Optionally you can enable a visual interface:
 
 ![Web interface](https://github.com/pawurb/rails-pg-extras/raw/main/pg-extras-ui-3.png)
 
+[rails-pg-extras-mcp gem](https://github.com/pawurb/rails-pg-extras-mcp) provides an MCP (Model Context Protocol) interface enabling PostgreSQL metadata and performance analysis with an LLM support.  
+
+![LLM interface](https://github.com/pawurb/rails-pg-extras/raw/main/pg-extras-mcp.png)
+
 Alternative versions:
 
 - Core dependency - [Ruby](https://github.com/pawurb/ruby-pg-extras)
@@ -59,6 +63,12 @@ By default a primary ActiveRecord database connection is used for running metada
 ENV["RAILS_PG_EXTRAS_DATABASE_URL"] = "postgresql://postgres:secret@localhost:5432/database_name"
 ```
 
+Alternatively, you can specify database URL with a method call:
+
+```ruby
+RailsPgExtras.database_url = "postgresql://postgres:secret@localhost:5432/database_name"
+```
+
 ## Usage
 
 Each command can be used as a rake task, or a directly from the Ruby code.
@@ -453,18 +463,18 @@ RailsPgExtras.outliers(args: { limit: 20 })
 
 $ rake pg_extras:outliers
 
-                   qry                   |    exec_time     | prop_exec_time |   ncalls    | sync_io_time
------------------------------------------+------------------+----------------+-------------+--------------
- SELECT * FROM archivable_usage_events.. | 154:39:26.431466 | 72.2%          | 34,211,877  | 00:00:00
- COPY public.archivable_usage_events (.. | 50:38:33.198418  | 23.6%          | 13          | 13:34:21.00108
- COPY public.usage_events (id, reporte.. | 02:32:16.335233  | 1.2%           | 13          | 00:34:19.784318
- INSERT INTO usage_events (id, retaine.. | 01:42:59.436532  | 0.8%           | 12,328,187  | 00:00:00
- SELECT * FROM usage_events WHERE (alp.. | 01:18:10.754354  | 0.6%           | 102,114,301 | 00:00:00
- UPDATE usage_events SET reporter_id =.. | 00:52:35.683254  | 0.4%           | 23,786,348  | 00:00:00
+                   qry                   |    exec_time     | prop_exec_time |   ncalls    | sync_io_time | avg_exec_ms
+-----------------------------------------+------------------+----------------+-------------+--------------+-------------
+ SELECT * FROM archivable_usage_events.. | 154:39:26.431466 | 72.2%          | 34,211,877  | 00:00:00     | 16.24
+ COPY public.archivable_usage_events (.. | 50:38:33.198418  | 23.6%          | 13          | 13:34:21.008 | 233845.63
+ COPY public.usage_events (id, reporte.. | 02:32:16.335233  | 1.2%           | 13          | 00:34:19.718 | 11689.72
+ INSERT INTO usage_events (id, retaine.. | 01:42:59.436532  | 0.8%           | 12,328,187  | 00:00:00     | 0.84
+ SELECT * FROM usage_events WHERE (alp.. | 01:18:10.754354  | 0.6%           | 102,114,301 | 00:00:00     | 0.77
+ UPDATE usage_events SET reporter_id =.. | 00:52:35.683254  | 0.4%           | 23,786,348  | 00:00:00     | 0.13
 (truncated results for brevity)
 ```
 
-This command displays statements, obtained from `pg_stat_statements`, ordered by the amount of time to execute in aggregate. This includes the statement itself, the total execution time for that statement, the proportion of total execution time for all statements that statement has taken up, the number of times that statement has been called, and the amount of time that statement spent on synchronous I/O (reading/writing from the file system).
+This command displays statements, obtained from `pg_stat_statements`, ordered by the amount of time to execute in aggregate. This includes the statement itself, the total execution time for that statement, the proportion of total execution time for all statements that statement has taken up, the number of times that statement has been called, the amount of time that statement spent on synchronous I/O (reading/writing from the file system), and the average execution time per call in milliseconds.
 
 Typically, an efficient query will have an appropriate ratio of calls to total execution time, with as little time spent on I/O as possible. Queries that have a high total execution time but low call count should be investigated to improve their performance. Queries that have a high proportion of execution time being spent on synchronous I/O should also be investigated.
 
@@ -477,17 +487,17 @@ RailsPgExtras.calls(args: { limit: 10 })
 
 $ rake pg_extras:calls
 
-                   qry                   |    exec_time     | prop_exec_time |   ncalls    | sync_io_time
------------------------------------------+------------------+----------------+-------------+--------------
- SELECT * FROM usage_events WHERE (alp.. | 01:18:11.073333  | 0.6%           | 102,120,780 | 00:00:00
- BEGIN                                   | 00:00:51.285988  | 0.0%           | 47,288,662  | 00:00:00
- COMMIT                                  | 00:00:52.31724   | 0.0%           | 47,288,615  | 00:00:00
- SELECT * FROM  archivable_usage_event.. | 154:39:26.431466 | 72.2%          | 34,211,877  | 00:00:00
- UPDATE usage_events SET reporter_id =.. | 00:52:35.986167  | 0.4%           | 23,788,388  | 00:00:00
+                   qry                   |    exec_time     | prop_exec_time |   ncalls    | sync_io_time | avg_exec_ms
+-----------------------------------------+------------------+----------------+-------------+--------------+-------------
+ SELECT * FROM usage_events WHERE (alp.. | 01:18:11.073333  | 0.6%           | 102,120,780 | 00:00:00     | 1
+ BEGIN                                   | 00:00:51.285988  | 0.0%           | 47,288,662  | 00:00:00     | 0
+ COMMIT                                  | 00:00:52.31724   | 0.0%           | 47,288,615  | 00:00:00     | 0
+ SELECT * FROM  archivable_usage_event.. | 154:39:26.431466 | 72.2%          | 34,211,877  | 00:00:00     | 16
+ UPDATE usage_events SET reporter_id =.. | 00:52:35.986167  | 0.4%           | 23,788,388  | 00:00:00     | 0
 (truncated results for brevity)
 ```
 
-This command is much like `pg:outliers`, but ordered by the number of times a statement has been called.
+This command is much like `pg:outliers`, but ordered by the number of times a statement has been called. 
 
 [More info](https://pawelurbanek.com/postgresql-fix-performance#missing-indexes)
 

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

@@ -12,6 +12,7 @@ require "rails_pg_extras/table_info"
 require "rails_pg_extras/table_info_print"
 
 module RailsPgExtras
+  @@database_url = nil
   QUERIES = RubyPgExtras::QUERIES
   DEFAULT_ARGS = RubyPgExtras::DEFAULT_ARGS
   NEW_PG_STAT_STATEMENTS = RubyPgExtras::NEW_PG_STAT_STATEMENTS
@@ -142,8 +143,14 @@ module RailsPgExtras
     RubyPgExtras.display_result(result, title: "Missing foreign key constraints", in_format: in_format)
   end
 
+  def self.database_url=(value)
+    @@database_url = value
+  end
+
   def self.connection
-    if (db_url = ENV["RAILS_PG_EXTRAS_DATABASE_URL"])
+    db_url = @@database_url || ENV["RAILS_PG_EXTRAS_DATABASE_URL"]
+
+    if db_url.present?
       connector = ActiveRecord::Base.establish_connection(db_url)
 
       if connector.respond_to?(:connection)

data/lib/rails_pg_extras/mcp_app.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require "fast_mcp"
+require "rack"
+require "rails_pg_extras/version"
+
+SKIP_QUERIES = %i[
+  add_extensions
+  pg_stat_statements_reset
+  kill_pid
+  kill_all
+  mandelbrot
+]
+
+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
+
+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)
+
+        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 = "5.6.12"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-pg-extras
 version: !ruby/object:Gem::Version
-  version: 5.6.10
+  version: 5.6.12
 platform: ruby
 authors:
 - pawurb
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-07 00:00:00.000000000 Z
+date: 2025-07-13 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: 5.6.12
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.6.10
+        version: 5.6.12
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -116,6 +116,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 +127,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