PostgreSQL Finder MCP server

This MCP Server PostgreDB Finder provides a simple way to find and interact with PostgreSQL databases. It's built with Bun, a fast JavaScript runtime, making it efficient and easy to deploy.

Installation

Before installing, ensure you have Bun installed on your system. Then follow these steps to set up the MCP Server:

# Clone the repository
git clone https://github.com/your-username/mcp-server-postgredb-finder.git

# Navigate to the project directory
cd mcp-server-postgredb-finder

# Install dependencies
bun install

Running the Server

Once installation is complete, you can start the server with:

bun run index.ts

The server will start and listen for incoming connections. By default, it runs on port 3000, but you can configure this in the settings.

Configuration

Environment Variables

Create a .env file in the root directory with the following variables:

PORT=3000
POSTGRES_HOST=localhost
POSTGRES_PORT=5432
POSTGRES_USER=postgres
POSTGRES_PASSWORD=yourpassword
POSTGRES_DB=yourdbname

Custom Server Settings

You can modify the server configuration by editing the config.ts file to adjust timeouts, connection limits, and other parameters.

Usage Examples

Querying Databases

To query available databases:

curl http://localhost:3000/api/databases

Connecting to a Specific Database

curl -X POST http://localhost:3000/api/connect -H "Content-Type: application/json" -d '{"database": "yourdbname"}'

Running SQL Queries

curl -X POST http://localhost:3000/api/query -H "Content-Type: application/json" -d '{"query": "SELECT * FROM your_table LIMIT 10;"}'

Troubleshooting

Common Issues

• Connection Refused: Ensure your PostgreSQL server is running and accessible
• Authentication Failed: Verify your database credentials in the .env file
• Port Already in Use: Change the PORT value in your .env file

Logs

Server logs are available in the console where you started the server. For more detailed logging, set the environment variable:

DEBUG=true

How to install this MCP server

For Claude Code

To add this MCP server to Claude Code, run this command in your terminal:

claude mcp add-json "postgredb-finder" '{"command":"bun","args":["run","index.ts"]}'

See the official Claude Code MCP documentation for more details.

For Cursor

There are two ways to add an MCP server to Cursor. The most common way is to add the server globally in the ~/.cursor/mcp.json file so that it is available in all of your projects.

If you only need the server in a single project, you can add it to the project instead by creating or adding it to the .cursor/mcp.json file.

Adding an MCP server to Cursor globally

To add a global MCP server go to Cursor Settings > Tools & Integrations and click "New MCP Server".

When you click that button the ~/.cursor/mcp.json file will be opened and you can add your server like this:

{
    "mcpServers": {
        "postgredb-finder": {
            "command": "bun",
            "args": [
                "run",
                "index.ts"
            ]
        }
    }
}

Adding an MCP server to a project

To add an MCP server to a project you can create a new .cursor/mcp.json file or add it to the existing one. This will look exactly the same as the global MCP server example above.

How to use the MCP server

Once the server is installed, you might need to head back to Settings > MCP and click the refresh button.

The Cursor agent will then be able to see the available tools the added MCP server has available and will call them when it needs to.

You can also explicitly ask the agent to use the tool by mentioning the tool name and describing what the function does.

For Claude Desktop

To add this MCP server to Claude Desktop:

1. Find your configuration file:

• macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%\Claude\claude_desktop_config.json
• Linux: ~/.config/Claude/claude_desktop_config.json

2. Add this to your configuration file:

{
    "mcpServers": {
        "postgredb-finder": {
            "command": "bun",
            "args": [
                "run",
                "index.ts"
            ]
        }
    }
}

3. Restart Claude Desktop for the changes to take effect