Slowplan

io.github.GillMacedo由 GitHub 帳號 GillMacedo 發布v0.1.0更新於 Nov 3, 2026

Find why a PostgreSQL query is slow from its EXPLAIN output, without a database connection.

已驗證STDIO僅桌面資料庫開發者工具

概覽

AI 產生的概覽

讀取 PostgreSQL 的 EXPLAIN 輸出,告訴助理查詢時間花在哪裡、該先修哪些問題,且不連線資料庫。

可以做什麼
  • 審閱單份 PostgreSQL 執行計畫,輸入可為文字或檔案,找出循序掃描丟棄大量資料列、資料列估算偏差、排序與雜湊寫到磁碟、巢狀迴圈重複執行等問題並排序
  • 比對修改前後的兩份計畫,顯示耗時變化以及哪些問題已修復、仍存在或新出現
  • 依計畫節點給出時間占比,並依節點占總時間的比例標示嚴重程度
  • 以規則編號(PG101 至 PG114)標出問題,涵蓋索引涵蓋範圍、平行 worker 不足與 JIT 開銷等
適用情境
適用於 PostgreSQL 查詢變慢、手邊已有 EXPLAIN (ANALYZE, BUFFERS) 輸出可貼上時,或想確認新建索引是否真的有效時。也適合不希望把資料庫憑證交給助理、只想讓它分析執行計畫的情境。
執行需求
以本機程序透過 stdio 執行,通常用 npx 搭配 Node 18 或更新版本(也提供 Go 安裝方式)。未宣告需要帳號、API 金鑰或環境變數。需要使用者提供計畫文字或 JSON;它本身不連線資料庫。
安裝前請注意
執行計畫可能包含查詢中的具體數值,而 MCP 用戶端會把工具結果傳送給其模型,分享前請檢查是否含敏感資料。建議的索引只是候選方案,僅基於一次執行和一組取值,應在真實資料上驗證。取得計畫時 ANALYZE 會實際執行查詢,寫入類語句請放在會回滾的交易中。

安裝

在 SourceWeft 中

  1. 開啟 儀表板中的 Slowplan,將其新增到工作區。
  2. 為需要使用其工具的對話啟用該服務。

Desktop only,透過 STDIO。 STDIO 服務會啟動本機處理程序,因此需要 SourceWeft 桌面主機。

其他 MCP 客戶端

參照 儲存庫 中的啟動說明。

README

slowplan: why is this PostgreSQL query slow?

[npm] [CI] [MIT license]

An MCP server and CLI that reads PostgreSQL EXPLAIN output and tells you where the time goes and what to try first. It works from the plan text alone, so it never connects to your database.

A long EXPLAIN ANALYZE is hard to read, and a mistake is easy: Postgres reports per-worker averages under parallel plans, and the slowest-looking node often isn't where the time went. slowplan works out the real time for each step, and ranks problems such as sequential scans throwing away rows, wrong row estimates, sorts and hashes spilling to disk, and nested loops run many times.

What you can ask your agent

  • "This Postgres query is slow. Here's the EXPLAIN ANALYZE output."
  • "Why is the planner doing a sequential scan here?"
  • "I added an index. Did it help?"
  • "What's the first thing to fix in this plan?"

Install

As a Claude Code plugin:

claude plugin marketplace add GillMacedo/slowplanclaude plugin install slowplan@slowplan-marketplace

As an MCP server, for any client:

{"mcpServers": {"slowplan": {"command": "npx", "args": ["-y", "[email protected]", "serve"]}}}

As a CLI, with Node 18 or newer:

npx slowplan review plan.txt

Or with Go 1.27 or newer: go install github.com/GillMacedo/slowplan@latest.

Usage

Get a plan with EXPLAIN (ANALYZE, BUFFERS) <your query>, in text or JSON. ANALYZE really runs the query, so wrap anything that writes in a transaction you roll back.

Here's a real plan from PostgreSQL 17, on made-up tables:

$ make demoExecution 48.9 ms, planning 0.3 ms
Where the time goes:   80.8%      39.5 ms  Bitmap Heap Scan on orders    3.9%       1.9 ms  Bitmap Index Scan on orders_status_idx
HIGH   PG102 Bitmap Heap Scan on orders  The index doesn't cover the whole filter. Read and threw away 84857 rows to keep 857, using filter (bucket = 7).  Try: Candidate to test: CREATE INDEX CONCURRENTLY ON orders (bucket), or add these columns to the index in use.
These are leads from one run. Test a fix on realistic data before relying on it.

To check a change, compare the plans from before and after:

slowplan compare before.txt after.txt

On a real example in examples/, adding the index that slowplan suggested took a query from about 25 ms to 0.1 ms.

Add --json for JSON, or --fail-on high to exit 1 in CI. Use - to read from stdin.

What it finds

RuleFinds
PG101A sequential scan throwing away most of the rows it reads
PG102An index that doesn't cover the whole filter
PG103A join producing rows and then throwing them away
PG104A bitmap recheck throwing away many rows
PG105Row estimates off by 10 times or more
PG106A nested loop's inner side running 1,000 times or more
PG107A sort spilling to disk
PG108A hash table split into batches on disk
PG109Fewer parallel workers than planned
PG110An index-only scan still visiting the table often
PG111A bitmap that became lossy
PG112Reading about 80 MB or more from outside shared buffers
PG113Planning slower than running the query
PG114JIT taking 100 ms or more

Severity comes from the share of the query's time: high is 20% or more, and low is under 5% or under 1 ms. These thresholds are judgment calls.

MCP tools

ToolDoes
postgres_plan_reviewReviews one plan, from text or a file
postgres_plan_compareCompares plans from before and after a change

Limits

  • Suggested indexes are candidates. A plan shows one query with one set of values, and not your other indexes or what an index costs on writes. Test on realistic data.
  • One run isn't a benchmark. A cold cache or a busy server changes timing.
  • It can't see locks, network time, or anything outside the plan. A plan with estimates only has nothing measured, and slowplan says so.
  • Times under parallel plans are estimates, because Postgres reports averages across workers.
  • PostgreSQL only. Text plans from other tools, or heavily edited ones, may not parse. JSON is the most reliable.
  • Plans can hold values from your query. slowplan stays on your machine, but your MCP client sends tool results to its model.

FAQ

How do I read EXPLAIN ANALYZE output? Give it to slowplan, which shows where the time goes.

Why is Postgres doing a sequential scan? Often there's no useful index, or the filter keeps so many rows that an index wouldn't help. PG101 shows how many rows were thrown away.

How do I find out if a sort or hash is using disk? PG107 and PG108 flag them.

How is this different from pev2 or postgres-mcp? pev2 is a visualizer for people. postgres-mcp connects to a live database. slowplan gives an agent ranked findings from plan text, with no database access.

Tested on

PG101, PG102, PG104 to PG112 fired on real plans from a PostgreSQL 17 database with made-up tables, which are in examples/ in both JSON and text. PG103, PG113 and PG114 are only tested on written examples. MCP tool calls were tested through the MCP Inspector. It hasn't been used on a real production query yet.

Contributing

Contributions are welcome, from people and from people working with AI agents. See CONTRIBUTING.md. Good first issues are listed here.

AI disclosure

This project was largely generated with Claude Code and reviewed by its maintainer.

About me

I'm Giulliano Macedo, and I build developer tools at GoTech Solutions. Follow along or get in touch:

If slowplan found your slow query, a star helps others find it.


Built by Giulliano Macedo, GoTech Solutions · LinkedIn · X

來源:README.md,提交 54491fa

工具

2

postgres_plan_compare

Compare two PostgreSQL query plans

Compares EXPLAIN output from before and after a change, such as a new index, and shows the timing change and which problems were fixed, remain or are new. It never connects to a database.

輸入參數afterbeforeafter_pathbefore_path

postgres_plan_review

Review a PostgreSQL query plan

Finds why a PostgreSQL query is slow from its EXPLAIN output, in text or JSON: where the time goes, and problems such as sequential scans throwing away rows, wrong row estimates, sorts and hashes spilling to disk, and nested loops run many times. Use after running EXPLAIN (ANALYZE, BUFFERS). It only reads the text you give it and never connects to a database. Suggested indexes are candidates to test.

輸入參數pathplan

版本歷史

1
  1. v0.1.0最新Nov 1, 2026

評分

已滿足適用檢查項的 90%

該評分衡量此收錄條目的完整程度,依據註冊中心條目、端點與公開來源計算得出。它不是對伺服器本身的評價,也不表示伺服器安全或目前可用:可連通性是帶日期的檢查結果,評分也不包含安裝量或使用者評價。

  • 近 30 天內可連通25 分
  • 已宣告認證方式10 分

    請在註冊中心條目中宣告憑證請求標頭,或保持端點能夠回應探測,以便判定其認證方式。

  • 已列出工具必需15 分
  • 描述必需15 分
  • 圖示10 分
  • 文件15 分
  • 授權條款10 分