mirror of
https://github.com/modelcontextprotocol/servers.git
synced 2026-04-18 00:03:23 +02:00
37 lines
1.1 KiB
Markdown
37 lines
1.1 KiB
Markdown
# PostgreSQL
|
|
|
|
A Model Context Protocol server that provides read-only access to PostgreSQL databases. This server enables LLMs to inspect database schemas and execute read-only queries.
|
|
|
|
## Components
|
|
|
|
### Tools
|
|
|
|
- **query**
|
|
- Execute read-only SQL queries against the connected database
|
|
- Input: `sql` (string): The SQL query to execute
|
|
- All queries are executed within a READ ONLY transaction
|
|
|
|
### Resources
|
|
|
|
The server provides schema information for each table in the database:
|
|
|
|
- **Table Schemas** (`postgres://<host>/<table>/schema`)
|
|
- JSON schema information for each table
|
|
- Includes column names and data types
|
|
- Automatically discovered from database metadata
|
|
|
|
## Example Usage with the Desktop App
|
|
|
|
To use this server with the Claude Desktop app, add the following configuration to the "mcpServers" section of your `claude_desktop_config.json`:
|
|
|
|
```json
|
|
"postgres": {
|
|
"command": "mcp-server-postgres",
|
|
"args": ["postgresql://localhost/mydb"],
|
|
"env": {
|
|
"HOME": "/Users/YOUR_USERNAME"
|
|
}
|
|
}
|
|
```
|
|
|
|
Replace `/mydb` with your database name and `YOUR_USERNAME` with your system username. |