Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions docs/mcp-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@

Model Context Protocol (MCP) server for querying TRUF.NETWORK data through AI Clients like Claude Desktop.

## Current Supported AI Client
## Currently Supported AI Client

1. Claude Desktop

Please inquiry for another client support.
Please inquire for support for other clients.

## Prerequisites

Expand All @@ -17,6 +18,7 @@ Please inquiry for another client support.
### Install Prerequisites

**macOS:**

```bash
# Install Python 3.12+
brew install python@3.12
Expand All @@ -27,6 +29,7 @@ pipx ensurepath
```

**Linux (Ubuntu/Debian):**

```bash
# Install Python 3.12+
sudo apt update && sudo apt install python3.12
Expand All @@ -37,6 +40,7 @@ python3 -m pipx ensurepath
```

**Windows:**

```bash
# Install Python 3.12+ from https://www.python.org/downloads/
# or use chocolatey:
Expand All @@ -53,14 +57,16 @@ Download from https://claude.ai/download
## Installation

1. **Clone and install:**

```bash
git clone https://github.com/trufnetwork/postgres-mcp.git
cd postgres-mcp
./install.sh
```

2. **Follow the prompts to configure:**
- Database connection details (default: localhost:5432/kwild), just use the default if you didn't custom anything.

- Database connection details (default: localhost:5432/kwild), just use the default if you didn't customize anything.

3. **Restart Claude Desktop**

Expand All @@ -78,16 +84,18 @@ cd postgres-mcp
## Troubleshooting

**Connection issues:**

- Verify your Kwil node is running
- Check database credentials
- Ensure PostgreSQL port 5432 is accessible from local

**Claude integration:**

- Restart Claude Desktop after installation
- Check config file: `~/Library/Application Support/Claude/claude_desktop_config.json`

## Uninstall

```bash
pipx uninstall postgres-mcp
```
```
Loading