Model Context Protocol

MCP API Documentation

Connect AI tools like Claude Code and Cursor to your Vaultbrix database. Let LLMs natively understand your schema, deploy migrations, and manage data.

What is MCP?

The Model Context Protocol (MCP) is an open standard that allows AI assistants like Claude, GPT, and Cursor to interact with external tools and data sources. Vaultbrix provides an MCP server that gives AI tools direct access to your database operations.

Schema Understanding

AI tools automatically understand your tables, columns, relationships, and constraints.

Direct Operations

Deploy migrations, query data, and manage your database directly from AI conversations.

Secure Access

Scoped API keys with granular permissions. Dangerous operations require confirmation.

Why use MCP instead of direct API calls?

MCP provides a standardized interface that AI tools understand natively. Instead of writing custom integrations, tools like Claude Code and Cursor can immediately work with your database using their built-in MCP support.

Authentication

Creating an API Key
API keys provide secure access to the MCP server for your AI tools.
1

Go to Dashboard → Settings → API

Find the "MCP API Keys" section

2

Click "Create API Key"

Choose a descriptive name like "Claude Code - Development"

3

Select permissions

Choose appropriate scopes: read, write, or admin

4

Copy and save your key

Important: The full key is only shown once. Store it securely.

API Key Format
Vaultbrix API keys follow a Stripe-style format for easy identification.
<vaultbrix-api-key>
└──┬───┘ └─────────────────┬─────────────────┘ └─┬─┘
 prefix      32 chars random                    checksum
vbx_live_...

Production access - full database operations

vbx_test_...

Test/sandbox only - safe for development

Permission Scopes
read

View schema, list tables, query data. Safe for browsing.

write

Create/modify tables, insert/update data, run migrations.

admin

Full access including dangerous operations (drop tables, truncate).

Quick Start

Claude Code Setup
Configure Claude Code to use Vaultbrix MCP

Add to ~/.claude/mcp.json:

{
  "mcpServers": {
    "vaultbrix": {
      "transport": "http",
      "url": "https://api.vaultbrix.com/mcp-manage",
      "headers": {
        "X-API-Key": "YOUR_API_KEY"
      }
    }
  }
}

The server also accepts Authorization: Bearer <jwt> if you prefer JWT-backed sessions.

Cursor Setup
Configure Cursor IDE to use Vaultbrix MCP

Add to .cursor/mcp.json in your project:

{
  "mcpServers": {
    "vaultbrix": {
      "transport": "http",
      "url": "https://api.vaultbrix.com/mcp-manage",
      "headers": {
        "X-API-Key": "YOUR_API_KEY"
      }
    }
  }
}
Direct HTTP Usage
Call the MCP API directly via HTTP
# List available tools
curl -H "X-API-Key: <vaultbrix-api-key>" \
  https://api.vaultbrix.com/mcp-manage/tools

# Execute a tool
curl -X POST \
  -H "X-API-Key: <vaultbrix-api-key>" \
  -H "Content-Type: application/json" \
  -d '{"arguments": {}}' \
  https://api.vaultbrix.com/mcp-manage/tools/list_projects

# Get tool details
curl -H "X-API-Key: <vaultbrix-api-key>" \
  https://api.vaultbrix.com/mcp-manage/tools/create_migration

Use /mcp-manage/tools to inspect the full catalog before wiring a client.

Available Tools

read
Read-Only Operations
Safe operations that don't modify data
list_projects

List accessible projects

get_project

Get project details and status

list_tables

List tables for a project

get_table_schema

Inspect a table definition

list_migrations

View migration history

execute_sql

Run read-only SQL against a project

write
Write Operations
Operations that modify data or schema
create_migration

Create and apply a SQL migration

execute_sql_write

Run INSERT, UPDATE, or DELETE queries

create_backup

Create a project backup

create_branch

Create a database branch

dangerous
Dangerous Operations
Destructive operations that require confirmation

These tools require an explicit confirm: true parameter to prevent accidental data loss.

delete_project

Permanently delete a project

restore_backup

Restore a backup snapshot

merge_branch

Merge a branch into production

rollback_migration

Revert a migration

Rate Limits

PlanMonthly OperationsRate (per minute)Memory Slots
Free50520
Starter2,00020200
Pro10,000601,000
Business50,000120Unlimited
EnterpriseUnlimitedCustomUnlimited

Rate Limit Headers

Every response includes rate limit information:

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 45
X-RateLimit-Reset: 1707840000

Security Best Practices

Rotate Keys Regularly

Rotate your API keys every 90 days. Use the "Rotate" button in settings to generate a new key while keeping the same permissions.

Principle of Least Privilege

Create separate keys for different purposes. A development tool only needs read access for schema exploration.

Use Environment Variables

Never hardcode API keys in your MCP configuration files. Use environment variables or secure secret management.

Set Expiration Dates

For temporary access (contractors, CI/CD), create keys with expiration dates that automatically revoke access.

If Your Key is Compromised

  1. 1. Immediately revoke the key in Dashboard → Settings → API
  2. 2. Create a new key with the same permissions
  3. 3. Update all integrations with the new key
  4. 4. Review the audit log for unauthorized access
  5. 5. Rotate any other credentials that may have been exposed

Ready to Connect Your AI Tools?

Create your first API key and start using MCP with Claude Code or Cursor.