Skip to content

Add database MCP configuration and instructions on how to use it #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
liam-lloyd merged 1 commit into from
Jun 2, 2026
Merged

Add database MCP configuration and instructions on how to use it #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions .env.template
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
DATABASE_PASSWORD=<ADD *READ-ONLY* DATABASE PASSWORD HERE>
DATABASE_HOST=<ADD *READ-ONLY* DATABASE HOST HERE>
11 changes: 10 additions & 1 deletion .mcp.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
{
"mcpServers": {}
"mcpServers": {
"db": {
"type": "stdio",
"command": "bash",
"args": [
"-c",
"source ./.env && npx dbhub --dsn postgres://prodreadonly:$DATABASE_PASSWORD@$DATABASE_HOST:5432/permanent"
]
}
}
}
25 changes: 11 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,9 @@

A conversational interface for querying our production data using Claude Code. Designed for non-technical staff — no SQL or programming knowledge required.

> **Note:** The database connection (a postgres MCP server) is being set up separately and is not part of this branch yet. Until it lands, sessions run but cannot query data.

## How It Works

You open Claude Code (locally or on the web), ask a question in plain English, and get an answer pulled from the data. For example:
You open Claude Code, ask a question in plain English, and get an answer pulled from the data. For example:

- "How many users signed up last month?"
- "Show me the top 10 customers by revenue"
Expand All @@ -16,27 +14,26 @@ Claude translates your question into a database query, runs it, and presents the

## Setup

There are two ways to use Roboterry: **locally** (Claude Code CLI or desktop app) or **on the web** (claude.ai/code).

### Local Setup

1. Install [Claude Code](https://claude.ai/download)
2. Clone this repository:
```
git clone <repository-url>
cd roboterry
```
3. Start Claude Code from inside the roboterry directory:
3. Run
```
cp .env.template .env
```
4. Set `DATABASE_PASSWORD` and `DATABASE_HOST` in your .env. This can be found in Bitwarden under "PostgreSQL prod read-only user"; the password unser "Password" and the host under "Website"
5. Run
```
npm install
```
6. Start Claude Code from inside the roboterry directory:
```
claude
```

### Web Setup

1. Go to [claude.ai/code](https://claude.ai/code)
2. Connect this repository as your project
3. Start a new session

## Usage Tips

- **Ask in plain English.** You don't need to know SQL or database terminology.
Expand Down
Loading