Skip to content

Commit bfd459f

Browse files
neverinfamousneverinfamous
committed
Update documentation.
1 parent 9da5023 commit bfd459f

File tree

4 files changed

+346
-3
lines changed

4 files changed

+346
-3
lines changed

‎DOCKER_README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# PostgreSQL MCP Server - Enhanced
22

3-
Last Updated November 24, 2025 - Production/Stable v1.1.1
3+
Last Updated December 6, 2025 - Production/Stable v1.1.1
44

55
<!-- mcp-name: io.github.neverinfamous/postgres-mcp-server -->
66

@@ -16,7 +16,7 @@ Last Updated November 24, 2025 - Production/Stable v1.1.1
1616

1717
*Enterprise-grade PostgreSQL MCP server with comprehensive security, AI-native operations, and intelligent meta-awareness*
1818

19-
**📰 [Read the v1.1.1 Release Article](https://adamic.tech/articles/2025-10-04-postgres-mcp-server-v1-0-5)** - Learn about enterprise features, AI-native operations, and intelligent meta-awareness
19+
**[GitHub](https://github.com/neverinfamous/postgres-mcp)** • **[Wiki](https://github.com/neverinfamous/postgres-mcp/wiki)** • **[Changelog](https://github.com/neverinfamous/postgres-mcp/wiki/Changelog)** • **[Release Article](https://adamic.tech/articles/postgres-mcp-server)**
2020

2121
---
2222

‎README.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# PostgreSQL MCP Server - Version 1.1.1
22

3-
Last Updated November 24, 2025 - Production/Stable v1.1.1
3+
Last Updated December 6, 2025 - Production/Stable v1.1.1
44

55
<!-- mcp-name: io.github.neverinfamous/postgres-mcp-server -->
66

@@ -17,6 +17,8 @@ Enterprise-grade PostgreSQL MCP server with enhanced security, comprehensive tes
1717
[![CodeQL](https://img.shields.io/badge/CodeQL-Passing-brightgreen.svg)](https://github.com/neverinfamous/postgres-mcp/security/code-scanning)
1818
[![Type Safety](https://img.shields.io/badge/Pyright-Strict-blue.svg)](https://github.com/neverinfamous/postgres-mcp)
1919

20+
**[GitHub](https://github.com/neverinfamous/postgres-mcp)** • **[Wiki](https://github.com/neverinfamous/postgres-mcp/wiki)** • **[Changelog](https://github.com/neverinfamous/postgres-mcp/wiki/Changelog)** • **[Release Article](https://adamic.tech/articles/postgres-mcp-server)**
21+
2022
---
2123

2224
## 🔍 **[AI-Powered Documentation Search →](https://search.adamic.tech)**

‎changelog.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Changelog
2+
3+
The PostgreSQL MCP Server changelog is maintained in the project wiki.
4+
5+
## 📚 View the Changelog
6+
7+
**Wiki:** [Changelog](https://github.com/neverinfamous/postgres-mcp/wiki)
8+
9+
**GitHub Repository:** [neverinfamous/postgres-mcp](https://github.com/neverinfamous/postgres-mcp)
10+
11+
---
12+
13+
The wiki changelog includes:
14+
- All version history and release notes
15+
- Detailed feature descriptions
16+
- Bug fixes and improvements
17+
- Breaking changes and migration guides
18+
19+
For the latest updates, always refer to the wiki.

‎releases/v1.1.1-release-notes.md‎

Lines changed: 322 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,322 @@
1+
# PostgreSQL MCP Server v1.1.1 Release Notes
2+
3+
**Release Date:** December 6, 2025
4+
**Status:** Production/Stable
5+
**Docker Image:** `writenotenow/postgres-mcp-enhanced:v1.1.1`
6+
**PyPI Package:** `postgres-mcp-enhanced v1.1.1`
7+
8+
---
9+
10+
## 🎉 What's New in v1.1.1
11+
12+
This is a **maintenance and stability release** building upon the major v1.1.0 intelligent assistant release. Version 1.1.1 focuses on reliability, performance improvements, and enhanced documentation.
13+
14+
### Key Improvements
15+
16+
✅ **Enhanced Stability**
17+
- Improved error handling across all 63 tools
18+
- More robust connection pool management
19+
- Better handling of edge cases in complex queries
20+
21+
✅ **Performance Optimizations**
22+
- Reduced memory footprint for resource operations
23+
- Optimized query performance metrics collection
24+
- Faster schema introspection for large databases
25+
26+
✅ **Documentation Enhancements**
27+
- Updated installation guides with clearer instructions
28+
- Expanded troubleshooting section with real-world solutions
29+
- Improved examples in wiki documentation
30+
31+
✅ **Security Updates**
32+
- Updated dependencies to latest secure versions
33+
- Enhanced input validation for edge cases
34+
- Continued zero-vulnerability status
35+
36+
---
37+
38+
## 📦 Complete Feature Set
39+
40+
### 63 MCP Tools Across 9 Categories
41+
42+
| Category | Tools | Description |
43+
|----------|-------|-------------|
44+
| **Core Database** | 9 | Schema management, SQL execution, health monitoring |
45+
| **JSON Operations** | 11 | JSONB operations, validation, security scanning |
46+
| **Text Processing** | 5 | Similarity search, full-text search, fuzzy matching |
47+
| **Statistical Analysis** | 8 | Descriptive stats, correlation, regression, time series |
48+
| **Performance Intelligence** | 6 | Query optimization, index tuning, workload analysis |
49+
| **Vector/Semantic Search** | 8 | Embeddings, similarity search, clustering |
50+
| **Geospatial** | 7 | Distance calculation, spatial queries, GIS operations |
51+
| **Backup & Recovery** | 4 | Backup planning, restore validation, scheduling |
52+
| **Monitoring & Alerting** | 5 | Real-time monitoring, capacity planning, alerting |
53+
54+
### 10 MCP Resources - Database Meta-Awareness
55+
56+
Real-time database context that AI can access automatically:
57+
58+
- **database://schema** - Complete database structure
59+
- **database://capabilities** - Server features and extensions
60+
- **database://performance** - Query performance metrics
61+
- **database://health** - Database health status
62+
- **database://extensions** - Extension inventory
63+
- **database://indexes** - Index usage statistics
64+
- **database://connections** - Connection pool status
65+
- **database://replication** - Replication lag and status
66+
- **database://vacuum** - Vacuum and wraparound status
67+
- **database://locks** - Lock contention information
68+
- **database://statistics** - Statistics quality
69+
70+
### 10 MCP Prompts - Guided Workflows
71+
72+
Step-by-step workflows for complex operations:
73+
74+
- **optimize_query** - Query optimization workflow
75+
- **index_tuning** - Index analysis and recommendations
76+
- **database_health_check** - Comprehensive health assessment
77+
- **setup_pgvector** - pgvector installation and setup
78+
- **json_operations** - JSONB best practices
79+
- **performance_baseline** - Baseline establishment
80+
- **backup_strategy** - Backup planning and design
81+
- **setup_postgis** - PostGIS installation and usage
82+
- **explain_analyze_workflow** - Deep plan analysis
83+
- **extension_setup** - Extension installation guide
84+
85+
---
86+
87+
## 🚀 Quick Start
88+
89+
### Docker (Recommended)
90+
91+
```bash
92+
# Pull the latest image
93+
docker pull writenotenow/postgres-mcp-enhanced:v1.1.1
94+
95+
# Run with your database connection
96+
docker run -i --rm \
97+
-e DATABASE_URI="postgresql://user:pass@localhost:5432/db" \
98+
writenotenow/postgres-mcp-enhanced:v1.1.1 \
99+
--access-mode=restricted
100+
```
101+
102+
### Python Installation
103+
104+
```bash
105+
# Install from PyPI
106+
pip install postgres-mcp-enhanced==1.1.1
107+
108+
# Run the server
109+
postgres-mcp --access-mode=restricted
110+
```
111+
112+
### One-Click Cursor Installation
113+
114+
[![Install to Cursor](https://img.shields.io/badge/Install%20to%20Cursor-Click%20Here-blue?style=for-the-badge)](cursor://anysphere.cursor-deeplink/mcp/install?name=PostgreSQL%20Enterprise%20MCP%20Server&config=eyJkb2NrZXIuaW8vd3JpdGVub3Rlbm93L3Bvc3RncmVzLW1jcC1lbmhhbmNlZDp2MS4xLjEiOnsidHJhbnNwb3J0Ijp7InR5cGUiOiJzdGRpbyJ9fX0=)
115+
116+
---
117+
118+
## 🔧 Configuration
119+
120+
### Claude Desktop
121+
122+
Add to `claude_desktop_config.json`:
123+
124+
```json
125+
{
126+
"mcpServers": {
127+
"postgres-mcp": {
128+
"command": "docker",
129+
"args": [
130+
"run", "-i", "--rm", "-e", "DATABASE_URI",
131+
"writenotenow/postgres-mcp-enhanced:v1.1.1",
132+
"--access-mode=restricted"
133+
],
134+
"env": {
135+
"DATABASE_URI": "postgresql://user:pass@localhost:5432/db"
136+
}
137+
}
138+
}
139+
}
140+
```
141+
142+
### Cursor IDE
143+
144+
Add to MCP settings:
145+
146+
```json
147+
{
148+
"mcpServers": {
149+
"postgres-mcp": {
150+
"command": "postgres-mcp",
151+
"args": ["--access-mode=restricted"],
152+
"env": {
153+
"DATABASE_URI": "postgresql://user:pass@localhost:5432/db"
154+
}
155+
}
156+
}
157+
}
158+
```
159+
160+
---
161+
162+
## 🛡️ Security & Quality
163+
164+
✅ **Zero Known Vulnerabilities** - Comprehensive security audit passed
165+
✅ **Pyright Strict Mode** - 100% type-safe codebase (2,000+ issues resolved)
166+
✅ **SQL Injection Prevention** - All queries use parameter binding
167+
✅ **20+ Security Tests** - All attack vectors covered
168+
✅ **CodeQL Scanning** - Continuous security monitoring
169+
✅ **Dual Security Modes** - Restricted (production) and unrestricted (development)
170+
171+
---
172+
173+
## 📚 Resources
174+
175+
### Documentation
176+
- **[Complete Wiki](https://github.com/neverinfamous/postgres-mcp/wiki)** - Full documentation with examples
177+
- **[Quick Start Guide](https://github.com/neverinfamous/postgres-mcp/wiki/Quick-Start)** - Get running in 30 seconds
178+
- **[Installation Guide](https://github.com/neverinfamous/postgres-mcp/wiki/Installation-and-Configuration)** - Detailed setup instructions
179+
- **[Security Best Practices](https://github.com/neverinfamous/postgres-mcp/wiki/Security-and-Best-practices)** - Production security
180+
- **[Troubleshooting](https://github.com/neverinfamous/postgres-mcp/wiki/Troubleshooting)** - Common issues and solutions
181+
182+
### Tools & Search
183+
- **[🔍 AI-Powered Documentation Search](https://search.adamic.tech)** - Natural language search across all tools
184+
- **[📝 GitHub Gists](https://gist.github.com/neverinfamous/7a47b6ca39857c7a8e06c4f7e6537a16)** - 7 practical examples and use cases
185+
- **[📰 Release Article](https://adamic.tech/articles/2025-10-04-postgres-mcp-server-v1-0-5)** - Deep dive into enterprise features
186+
187+
### Distribution
188+
- **[🐳 Docker Hub](https://hub.docker.com/r/writenotenow/postgres-mcp-enhanced)** - Container images
189+
- **[📦 PyPI Package](https://pypi.org/project/postgres-mcp-enhanced/)** - Python distribution
190+
- **[🌐 MCP Registry](https://registry.modelcontextprotocol.io/v0/servers?search=io.github.neverinfamous/postgres-mcp-server)** - Official MCP listing
191+
192+
---
193+
194+
## 🔄 Upgrade Guide
195+
196+
### From v1.1.0 to v1.1.1
197+
198+
This is a **drop-in replacement** with no breaking changes:
199+
200+
**Docker:**
201+
```bash
202+
docker pull writenotenow/postgres-mcp-enhanced:v1.1.1
203+
# Update your config to use v1.1.1 tag
204+
```
205+
206+
**Python:**
207+
```bash
208+
pip install --upgrade postgres-mcp-enhanced
209+
```
210+
211+
**No configuration changes required** - All existing configurations work unchanged.
212+
213+
### From v1.0.x to v1.1.1
214+
215+
All v1.0.x tools remain fully functional. You gain:
216+
- ✨ 10 new MCP Resources for database meta-awareness
217+
- ✨ 10 new MCP Prompts for guided workflows
218+
- ✨ Enhanced AI assistant capabilities
219+
- ✨ Improved performance and stability
220+
221+
**No breaking changes** - Upgrade with confidence!
222+
223+
---
224+
225+
## 🐛 Bug Fixes
226+
227+
- Fixed edge case in connection pool management under high load
228+
- Improved error messages for extension-related failures
229+
- Enhanced handling of very large result sets
230+
- Corrected resource caching behavior in certain scenarios
231+
- Fixed minor type annotations for improved IDE support
232+
233+
---
234+
235+
## 📊 Technical Specifications
236+
237+
- **PostgreSQL Compatibility:** 13, 14, 15, 16, 17, 18
238+
- **Python Version:** 3.10+
239+
- **Platform Support:** Windows, Linux, macOS (amd64, arm64)
240+
- **Container Size:** ~150MB compressed
241+
- **Dependencies:** Fully pinned and audited
242+
- **Code Quality:** Pyright strict mode, zero linter errors
243+
- **Test Coverage:** 90%+ with comprehensive integration tests
244+
245+
---
246+
247+
## 🏆 Why Choose This Server?
248+
249+
✅ **Most Comprehensive** - 63 tools + 10 resources + 10 prompts
250+
✅ **Production Ready** - Zero known vulnerabilities, enterprise-grade
251+
✅ **AI-Native** - Vector search, semantic operations, ML-ready
252+
✅ **Intelligent** - Meta-awareness and guided workflows
253+
✅ **Active Maintenance** - Regular updates and security patches
254+
✅ **Well Documented** - 16-page wiki + AI-powered search
255+
✅ **Type Safe** - 100% Pyright strict mode compliance
256+
✅ **Multi-Platform** - Docker + Python + pip installation options
257+
258+
---
259+
260+
## 📝 Changelog Summary
261+
262+
### v1.1.1 (December 6, 2025)
263+
- Enhanced stability and error handling
264+
- Performance optimizations for large databases
265+
- Documentation improvements
266+
- Security dependency updates
267+
- Bug fixes for edge cases
268+
269+
### v1.1.0 (October 4, 2025)
270+
- Added 10 MCP Resources for database meta-awareness
271+
- Added 10 MCP Prompts for guided workflows
272+
- Transformed into intelligent database assistant
273+
- Pyright strict mode compliance (2,000+ issues resolved)
274+
- Zero breaking changes
275+
276+
### v1.0.0 (October 3, 2025)
277+
- Production release with 63 specialized tools
278+
- Enterprise-grade security and testing
279+
- Multi-platform Docker support
280+
- Comprehensive documentation
281+
282+
---
283+
284+
## 🤝 Contributing
285+
286+
We welcome contributions! See our [Contributing Guide](https://github.com/neverinfamous/postgres-mcp/blob/main/CONTRIBUTING.md) for details.
287+
288+
**Report Issues:** [GitHub Issues](https://github.com/neverinfamous/postgres-mcp/issues)
289+
**Security:** Report vulnerabilities to admin@adamic.tech
290+
**Discussions:** [GitHub Discussions](https://github.com/neverinfamous/postgres-mcp/discussions)
291+
292+
---
293+
294+
## 📄 License
295+
296+
MIT License - See [LICENSE](https://github.com/neverinfamous/postgres-mcp/blob/main/LICENSE) file for details.
297+
298+
---
299+
300+
## 🙏 Acknowledgments
301+
302+
Thank you to the PostgreSQL community, MCP developers, and all contributors who made this release possible!
303+
304+
---
305+
306+
**⭐ If you find this project useful, please star it on GitHub!**
307+
308+
**📥 Download:**
309+
- Docker: `docker pull writenotenow/postgres-mcp-enhanced:v1.1.1`
310+
- PyPI: `pip install postgres-mcp-enhanced==1.1.1`
311+
- Source: [GitHub Release](https://github.com/neverinfamous/postgres-mcp/releases/tag/v1.1.1)
312+
313+
**🔗 Quick Links:**
314+
- [📚 Documentation](https://github.com/neverinfamous/postgres-mcp/wiki)
315+
- [🔍 AI Search](https://search.adamic.tech)
316+
- [🐳 Docker Hub](https://hub.docker.com/r/writenotenow/postgres-mcp-enhanced)
317+
- [📦 PyPI](https://pypi.org/project/postgres-mcp-enhanced/)
318+
319+
---
320+
321+
*Enterprise-grade PostgreSQL MCP server with comprehensive security, real-time analytics, and AI-native operations.*
322+

0 commit comments

Comments
 (0)