Skip to content

Commit 5128504

Browse files
authored
DBA-739 readme improve feature list (#60)
- changed features table to a list for better formatting on small screens - other minor copy updates
1 parent 94a1b9c commit 5128504

File tree

1 file changed

+14
-49
lines changed

1 file changed

+14
-49
lines changed

README.md

Lines changed: 14 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,16 @@
88
[![Twitter Follow](https://img.shields.io/twitter/follow/auto_dba?style=flat)](https://x.com/auto_dba)
99
[![Contributors](https://img.shields.io/github/contributors/crystaldba/postgres-mcp)](https://github.com/crystaldba/postgres-mcp/graphs/contributors)
1010

11-
<h3>A Postgres MCP server with index tuning, explain plans, health checks, and safe sql execution</h3>
11+
<h3>A Postgres MCP server with index tuning, explain plans, health checks, and safe sql execution.</h3>
1212

1313
<div class="toc">
1414
<a href="#overview">Overview</a> •
1515
<a href="#demo">Demo</a> •
1616
<a href="#quick-start">Quick Start</a> •
1717
<a href="#technical-notes">Technical Notes</a> •
1818
<a href="#mcp-server-api">MCP API</a> •
19-
<a href="#related-projects">Related Projects</a>
19+
<a href="#related-projects">Related Projects</a> •
20+
<a href="#frequently-asked-questions">FAQ</a>
2021
</div>
2122

2223
</div>
@@ -29,46 +30,11 @@ Postgres MCP Pro does much more than wrap a database connection.
2930

3031
Features include:
3132

32-
<table>
33-
<tr>
34-
<td width="50%">
35-
<h4>🔍 Database Health</h4>
36-
<ul>
37-
<li>Detect unused/duplicate indexes</li>
38-
<li>Monitor cache hit rates</li>
39-
<li>Check connection utilization</li>
40-
<li>Identify vacuum needs before problems occur</li>
41-
</ul>
42-
</td>
43-
<td width="50%">
44-
<h4>⚡ Index Tuning</h4>
45-
<ul>
46-
<li>Generate optimal indexes using proven algorithms</li>
47-
<li>Validate AI-suggested indexes</li>
48-
<li>Simulate performance impacts with hypothetical indexes</li>
49-
<li>Balance performance gain vs storage costs</li>
50-
</ul>
51-
</td>
52-
</tr>
53-
<tr>
54-
<td width="50%">
55-
<h4>📊 Schema Intelligence</h4>
56-
<ul>
57-
<li>Detailed schema information for tables, views & more</li>
58-
<li>Context-aware SQL generation</li>
59-
<li>Optimal column selection recommendations</li>
60-
</ul>
61-
</td>
62-
<td width="50%">
63-
<h4>🔒 Protected Execution</h4>
64-
<ul>
65-
<li><b>Unrestricted Mode:</b> Full read/write for development</li>
66-
<li><b>Restricted Mode:</b> Read-only with resource limits for production</li>
67-
<li>Safe SQL parsing to prevent security issues</li>
68-
</ul>
69-
</td>
70-
</tr>
71-
</table>
33+
- **🔍 Database Health** - analyze index health, connection utilization, buffer cache, vacuum health, sequence limits, replication lag, and more.
34+
- **⚡ Index Tuning** - explore thousands of possible indexes to find the best solution for your workload, using industrial-strength algorithms.
35+
- **📈 Query Plans** - validate and optimize performance by reviewing EXPLAIN plans and simulating the impact of hypothetical indexes.
36+
- **🧠 Schema Intelligence** - context-aware SQL generation based on detailed understanding of the database schema.
37+
- **🛡️ Safe SQL Execution** - configurable access control, including support for read-only mode and safe SQL parsing, making it usable for both development and production.
7238

7339
Postgres MCP Pro supports both the [Standard Input/Output (stdio)](https://modelcontextprotocol.io/docs/concepts/transports#standard-input%2Foutput-stdio) and [Server-Sent Events (SSE)](https://modelcontextprotocol.io/docs/concepts/transports#server-sent-events-sse) transports, for flexibility in different environments.
7440

@@ -77,14 +43,13 @@ For additional background on why we built Postgres MCP Pro, see [our launch blog
7743
## Demo
7844

7945
*From Unusable to Lightning Fast*
46+
- **Challenge:** We generated a movie app using an AI assistant, but the SQLAlchemy ORM code ran painfully slow.
47+
- **Solution:** Using Postgres MCP Pro with Cursor, we fixed the performance issues in minutes.
8048

81-
- **Challenge:** We generated a movie app using an AI assistant, but the SQLAlchemy ORM code ran painfully slowly
82-
- **Solution:** Using Postgres MCP Pro with Cursor, we fixed the performance issues in minutes
83-
84-
**We used the Cursor AI agent and Postgres MCP Pro to:**
85-
- 🚀 Fix performance - including ORM queries, indexing, and caching
86-
- 🛠️ Fix bugs that require connecting data to code
87-
- 🧠 Add new features from single prompts
49+
What we did:
50+
- 🚀 Fixed performance - including ORM queries, indexing, and caching
51+
- 🛠️ Fixed a broken page - by prompting the agent to explore the data, fix queries, and add related content.
52+
- 🧠 Improved the top movies - by exploring the data and fixing the ORM query to surface more relevant results.
8853

8954
See the video below or read the [play-by-play](examples/movie-app.md).
9055

0 commit comments

Comments
 (0)