Skip to content

Commit

Permalink
Updated Postgres
Browse files Browse the repository at this point in the history
  • Loading branch information
maheshmurag committed Nov 20, 2024
1 parent 6bcc0d2 commit e823044
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 32 deletions.
42 changes: 13 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,21 @@
# PostgreSQL
# MCP servers ![NPM Version](https://img.shields.io/npm/v/%40modelcontextprotocol%2Fexample-servers)

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.
Example servers for the Model Context Protocol, to demonstrate the kinds of things you can do!

## Components
## Getting started

### Tools
Install from npm:

- **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
```sh
npm install -g @modelcontextprotocol/servers
```

To use this server with the Claude Desktop app, add the following configuration to the "mcpServers" section of your `claude_desktop_config.json`:
Then, the servers will be globally available on your PATH:

```json
"postgres": {
"command": "mcp-server-postgres",
"args": ["postgresql://localhost/mydb"],
"env": {
"HOME": "/Users/YOUR_USERNAME"
}
}
```sh
mcp-server-everything
mcp-server-postgres
# ...
```

Replace `/mydb` with your database name and `YOUR_USERNAME` with your system username.
Each server will operate differently. See the READMEs within [src](src/) for more information.
35 changes: 33 additions & 2 deletions src/postgres/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,34 @@
# PostgreSQL server
# PostgreSQL

This MCP server provides **resources** and **tools** for interacting with a Postgres database.
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"]
}
```

Replace `/mydb` with your database name.
2 changes: 1 addition & 1 deletion src/postgres/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
"watch": "tsc --watch"
},
"dependencies": {
"@modelcontextprotocol/sdk": "0.5.0",
"@modelcontextprotocol/sdk": "0.6.2",
"pg": "^8.13.0"
},
"devDependencies": {
Expand Down

0 comments on commit e823044

Please sign in to comment.