Skip to content

Fix the Python wheel build (CI has been red since 2025-12) #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JaviMaligno merged 1 commit into from
Jul 29, 2026
Merged

Fix the Python wheel build (CI has been red since 2025-12) #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion python/README.md
View file
Open in desktop

This file was deleted.

57 changes: 57 additions & 0 deletions python/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# postgresql-mcp (Python)

MCP server for PostgreSQL database operations. Works with Claude Code, Claude Desktop, Cursor, and any MCP-compatible client.

This is the **Python** implementation. A TypeScript implementation with the same
tool set lives in [`/typescript`](https://github.com/JaviMaligno/postgres_mcp/tree/main/typescript)
and is published to npm as `postgresql-mcp`.

> This file used to be a symlink to the repository root README. That made the
> published source distribution carry a dangling link, which broke the wheel
> build — so it is a real file now, deliberately kept short. **The full
> documentation is in the [repository README](https://github.com/JaviMaligno/postgres_mcp#readme).**

## Install

```bash
pipx install postgresql-mcp
```

## Configure

```bash
claude mcp add postgres -s user \
-e POSTGRES_HOST=localhost \
-e POSTGRES_USER=your_user \
-e POSTGRES_PASSWORD=your_password \
-e POSTGRES_DB=your_database \
-- postgresql-mcp
```

| Variable | Required | Default | Description |
|----------|----------|---------|-------------|
| `POSTGRES_HOST` | | `localhost` | Database host |
| `POSTGRES_PORT` | | `5432` | Database port |
| `POSTGRES_USER` | ✅ | | Database user |
| `POSTGRES_PASSWORD` | ✅ | | Database password |
| `POSTGRES_DB` | ✅ | | Database name |
| `POSTGRES_SSLMODE` | | `prefer` | SSL mode |
| `ALLOW_WRITE_OPERATIONS` | | `false` | Enable INSERT/UPDATE/DELETE |
| `QUERY_TIMEOUT` | | `30` | Query timeout in seconds |
| `MAX_ROWS` | | `1000` | Maximum rows returned per query |

## What it provides

- **14 tools** — query execution, schema exploration, table analysis, EXPLAIN plans
- **4 prompts** — guided workflows for exploration, query building, performance analysis and documentation
- **Resources** — browsable database structure as markdown
- **Read-only by default**, with SQL injection prevention and credential protection

See the [full documentation](https://github.com/JaviMaligno/postgres_mcp#readme) for
the complete tool reference, security model, and the
[installation guide](https://github.com/JaviMaligno/postgres_mcp/blob/main/docs/INSTALLATION.md)
for database permissions and remote connections.

## License

MIT
Loading