Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings
Temp edited this page Oct 9, 2025 · 4 revisions

PostgreSQL MCP Server Wiki - Complete Documentation

Version 1.1.1 - Production/Stable - Updated October 9, 2025

This folder contains 17 comprehensive wiki pages for the PostgreSQL MCP Server.


📋 What's Included

Getting Started (5 pages)

  1. Home.md - Main landing page with overview and navigation
  2. Quick-Start.md - 30-second installation and setup guide
  3. Installation-and-Configuration.md - Detailed installation guide
  4. Extension-Setup.md - PostgreSQL extension installation (pg_stat_statements, pgvector, PostGIS, etc.)
  5. MCP-Configuration.md - Configure with Claude Desktop, Cursor, and other MCP clients

AI Features (1 page) - ⭐ NEW in v1.1.0

  1. MCP-Resources-and-Prompts.md - 10 resources + 10 prompts for AI-native intelligence

Tool Categories (9 pages)

  1. Core-Database-Tools.md - 9 essential database operations
  2. Performance-Intelligence.md - 6 query optimization and index tuning tools
  3. JSON-Operations.md - 15 JSONB tools (insert, update, query, validation, security)
  4. Text-Processing.md - 6 text similarity and full-text search tools
  5. Statistical-Analysis.md - 8 statistical analysis tools
  6. Vector-Semantic-Search.md - 8 pgvector semantic search tools
  7. Geospatial-Operations.md - 7 PostGIS geospatial tools
  8. Monitoring-Alerting.md - 5 real-time monitoring and alerting tools
  9. Backup-Recovery.md - 4 backup planning and recovery tools

Reference (2 pages)

  1. Security-and-Best-Practices.md - Enterprise security, SQL injection prevention, access control
  2. Troubleshooting.md - Common issues and solutions

🚀 Quick Upload (30 seconds)

Option 1: Automated Script (Easiest)

cd C:\Users\chris\Desktop\postgres-mcp-server-wiki
.\upload-wiki.ps1

Option 2: Manual Commands

# Clone wiki repo
cd C:\Users\chris\Desktop
git clone https://github.com/neverinfamous/postgres-mcp.wiki.git
cd postgres-mcp.wiki
# Copy files
Copy-Item C:\Users\chris\Desktop\postgres-mcp-server-wiki\*.md . -Force
# Push to GitHub
git add *.md
git commit -m "Add comprehensive PostgreSQL MCP Server wiki documentation (12 pages)"
git push origin master

📊 Documentation Stats

Metric Value
Total Pages 17
Total Words ~20,000
Code Examples 150+
Tools Documented 63
Resources Documented 10 (NEW v1.1.0)
Prompts Documented 10 (NEW v1.1.0)
Categories 9

🎯 Key Improvements Over SQLite Wiki

1. Better Structure

  • ✅ 12 focused pages vs 15 fragmented pages
  • ✅ Clear hierarchy: Getting Started → Tools → Reference
  • ✅ No content duplication

2. Phase 5 Documentation

  • Monitoring & Alerting - Real-time monitoring, capacity planning, replication monitoring
  • Backup & Recovery - Logical/physical backup planning, restore validation
  • ✅ Complete workflows and examples
  • ✅ Production-ready best practices

3. Enhanced Content

  • ✅ 100+ working code examples
  • ✅ Complete tool parameter documentation
  • ✅ Common workflows and use cases
  • ✅ Troubleshooting guides
  • ✅ Security best practices

4. Production Focus

  • ✅ Docker deployment examples
  • ✅ Security modes (restricted/unrestricted)
  • ✅ SSL/TLS configuration
  • ✅ Connection pooling
  • ✅ Performance tuning

📚 Wiki Structure Comparison

SQLite MCP Wiki (15 pages)

├── Home
├── Quick Start
├── Installation & Configuration
├── Core Database Tools
├── PRAGMA Operations
├── Full-Text Search
├── JSON Helper Tools
├── Advanced Text Processing
├── Statistical Analysis
├── Enhanced Virtual Tables
├── Vector Index Optimization
├── Semantic Vector Search
├── SpatiaLite Geospatial
├── Security & Data Integrity
├── Best Practices
├── Backup & Restore
├── Virtual Tables
├── MCP Resources & Prompts
└── Troubleshooting

PostgreSQL MCP Wiki (17 pages) - v1.1.1

Getting Started
├── Home (navigation hub)
├── Quick Start
├── Installation & Configuration
├── Extension Setup
└── MCP Configuration
AI Features ⭐ NEW v1.1.0
└── MCP Resources & Prompts (10 + 10)
Tool Categories
├── Core Database Tools (9 tools)
├── Performance Intelligence (6 tools)
├── JSON Operations (15 tools)
├── Text Processing (6 tools)
├── Statistical Analysis (8 tools)
├── Vector/Semantic Search (8 tools)
├── Geospatial Operations (7 tools)
├── Monitoring & Alerting (5 tools)
└── Backup & Recovery (4 tools)
Reference
├── Security & Best Practices
└── Troubleshooting

✨ What's New in v1.1.0

MCP Resources (10) - Real-time database meta-awareness

  1. Database Schema - All tables, columns, types
  2. Database Capabilities - Extensions, features
  3. Performance Metrics - Top queries, cache hits
  4. Database Health - Connection pool, indexes
  5. Extension Status - pgvector, PostGIS
  6. Index Statistics - Usage, size, recommendations
  7. Connection Pool - Active connections, utilization
  8. Replication Status - Lag, health
  9. Vacuum Status - Bloat, last vacuum times
  10. Lock Information - Active locks, blocking queries

MCP Prompts (10) - Guided workflows

  1. Optimize Query - Step-by-step optimization
  2. Index Tuning - Comprehensive recommendations
  3. Database Health Check - Full assessment
  4. Setup pgvector - Vector search setup
  5. Setup PostGIS - Geospatial setup
  6. JSONB Best Practices - Optimization guide
  7. Performance Baseline - Establish baselines
  8. Backup Strategy - Comprehensive planning
  9. Extension Setup - Step-by-step installation
  10. Query Analysis - Deep dive analysis

Code Quality

  • ✅ Pyright strict mode - 2,000+ type issues resolved
  • ✅ Zero linter errors - 100% type-safe codebase

🔗 Links


📝 Content Highlights

Security Documentation

  • ✅ SQL injection prevention with examples
  • ✅ Parameter binding best practices
  • ✅ Dual security modes explained
  • ✅ SSL/TLS configuration
  • ✅ Production security checklist

Performance Documentation

  • ✅ Query optimization workflows
  • ✅ Index recommendations with DTA algorithm
  • ✅ Hypothetical index testing
  • ✅ Workload analysis
  • ✅ Real-time monitoring

Operations Documentation

  • ✅ Backup strategies (logical + physical)
  • ✅ Restore validation and RTO calculation
  • ✅ Capacity planning and growth forecasting
  • ✅ Replication monitoring
  • ✅ Alert threshold configuration

🎉 Ready to Upload!

  1. Run .\upload-wiki.ps1 (automated)
  2. Or follow manual steps in UPLOAD_INSTRUCTIONS.md
  3. Visit https://github.com/neverinfamous/postgres-mcp/wiki
  4. Celebrate! 🎊

📧 Questions?


Updated: October 9, 2025 - Version 1.1.1 - Production/Stable

Clone this wiki locally

AltStyle によって変換されたページ (->オリジナル) /