# wpostgresql-mcp

MCP Server for WPostgreSQL Architecting — teaches AI agents how to build high-performance PostgreSQL-backed systems with the **wpostgresql** library.

## Features

- **10 Architect Tools**: Blueprints, manual, catalog search, scaffolding, connection validation, pattern generation
- **20 Offline Patterns**: All core wpostgresql features cataloged with module references
- **Scaffolding Generator**: Deploys full project structure with config, models, repositories, migrations, main.py
- **Live Connection Validation**: Tests PostgreSQL connectivity via psycopg 3 and returns health status
- **Pattern-based Generation**: Generates starter projects from catalog patterns

## Installation

```bash
# Clone and install
cd wpostgresql-mcp
pip install -e .
```

Or use the installer:

```bash
chmod +x installer.sh
./installer.sh
```

## Quick Start

```bash
# Run the MCP server in stdio mode (for agent integration)
wpostgresql-mcp run

# Get configuration for your AI agent
wpostgresql-mcp config

# Start as background SSE server
wpostgresql-mcp start
```

## Available Tools

| Tool | Description |
|------|-------------|
| `get_wpostgresql_architect_blueprints` | Complete CRUD, async, batch, transaction, pool, sync, query builder, SQLite backup (wsqlite) examples |
| `get_wpostgresql_architect_manual` | Expert rules, module map, data structure selection guide |
| `search_wpostgresql_pattern` | Search 20+ PostgreSQL patterns in official/community catalogs |
| `deploy_wpostgresql_scaffolding` | Generate full project structure with config/models/repos/migrations |
| `validate_postgresql_connection` | Live health check against a running PostgreSQL instance |
| `generate_from_pattern` | Generate project + example from a specific catalog pattern |

## Agent Integration

### Gemini CLI

```bash
gemini mcp add wpostgresql-mcp python3 -m wpostgresql_mcp.server run
```

### Claude Desktop / Cursor

```json
{
  "mcpServers": {
    "wpostgresql-mcp": {
      "command": "python3",
      "args": ["-m", "wpostgresql_mcp.server", "run"]
    }
  }
}
```

### OpenCode

Add to `.opencode/config.json`:

```json
{
  "mcpServers": {
    "wpostgresql-mcp": {
      "command": "python3",
      "args": ["-m", "wpostgresql_mcp.server", "run"]
    }
  }
}
```

## Commands

| Command | Description |
|---------|-------------|
| `wpostgresql-mcp run` | Run in stdio mode (default) |
| `wpostgresql-mcp run-sse` | Run in SSE mode |
| `wpostgresql-mcp start` | Start as background SSE server |
| `wpostgresql-mcp stop` | Stop background server |
| `wpostgresql-mcp config` | Print/save JSON configuration |
| `wpostgresql-mcp help` | Show help |

---

*Generated by WPostgreSQL MCP by **wisrovi***