servers/src/postgres
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2024-11-25 13:35:36 -06:00
..
index.ts Initial commit 2024-11-19 13:29:12 +00:00
package.json Pre-emptive version bump 2024-11-25 13:35:36 -06:00
README.md README Cleanup (#30) 2024-11-24 03:27:08 +00:00
tsconfig.json Create package for each server 2024-11-19 14:26:59 +00:00

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

Usage with Claude Desktop

To use this server with the Claude Desktop app, add the following configuration to the "mcpServers" section of your claude_desktop_config.json:

{
  "postgres": {
    "command": "npx",
    "args": ["-y", "@modelcontextprotocol/server-postgres", "postgresql://localhost/mydb"]
  }
}

Replace /mydb with your database name.

License

This MCP server is licensed under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more details, please see the LICENSE file in the project repository.