Skip to content

Commit f4a0e4d

Browse files
committed
README Installation update
1 parent cbbd9d9 commit f4a0e4d

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
A Model Context Protocol (MCP) server for PostgreSQL databases with enhanced capabilities for AI agents.
44

5+
More info on the pg-mcp project here:
6+
### [https://stuzero.github.io/pg-mcp/](https://stuzero.github.io/pg-mcp/)
7+
58
## Overview
69

710
PG-MCP is a server implementation of the [Model Context Protocol](https://modelcontextprotocol.io) for PostgreSQL databases. It provides a comprehensive API for AI agents to discover, connect to, query, and understand PostgreSQL databases through MCP's resource-oriented architecture.
@@ -75,12 +78,11 @@ docker-compose up -d
7578
git clone https://github.com/stuzero/pg-mcp.git
7679
cd pg-mcp
7780

78-
# Create and activate a virtual environment
79-
python -m venv .venv
80-
source .venv/bin/activate # On Windows: .venv\Scripts\activate
81+
# Install dependencies and create a virtual environment ( .venv )
82+
uv sync
8183

82-
# Install using uv
83-
uv sync --frozen
84+
# Activate the virtual environment
85+
source .venv/bin/activate # On Windows: .venv\Scripts\activate
8486

8587
# Run the server
8688
python -m server.app
@@ -97,7 +99,7 @@ The repository includes test scripts to verify server functionality:
9799
python test.py "postgresql://username:password@hostname:port/database"
98100

99101
# Claude-powered natural language to SQL conversion
100-
python client/claude_cli.py "Show me the top 5 customers by total sales"
102+
python example-clients/claude_cli.py "Show me the top 5 customers by total sales"
101103
```
102104

103105
The `claude_cli.py` script requires environment variables:
@@ -127,6 +129,9 @@ You can explore schema resources via:
127129
pgmcp://{conn_id}/schemas
128130
pgmcp://{conn_id}/schemas/{schema}/tables
129131
pgmcp://{conn_id}/schemas/{schema}/tables/{table}/columns
132+
133+
A comprehensive database description is available at this resource:
134+
pgmcp://{conn_id}/
130135
```
131136

132137
## Architecture

0 commit comments

Comments
 (0)