Updated Postgres

This commit is contained in:
Mahesh Murag
2024-11-20 11:05:58 -05:00
parent 6bcc0d2a8c
commit e8230448ad
3 changed files with 49 additions and 34 deletions

View File

@@ -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
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"
}
}
```sh
npm install -g @modelcontextprotocol/servers
```
Replace `/mydb` with your database name and `YOUR_USERNAME` with your system username.
Then, the servers will be globally available on your PATH:
```sh
mcp-server-everything
mcp-server-postgres
# ...
```
Each server will operate differently. See the READMEs within [src](src/) for more information.

View File

@@ -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.

View File

@@ -19,7 +19,7 @@
"watch": "tsc --watch"
},
"dependencies": {
"@modelcontextprotocol/sdk": "0.5.0",
"@modelcontextprotocol/sdk": "0.6.2",
"pg": "^8.13.0"
},
"devDependencies": {