-
Notifications
You must be signed in to change notification settings - Fork 671
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
6bcc0d2
commit e823044
Showing
3 changed files
with
47 additions
and
32 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters