Skip to main content

SQLSaber - Agentic SQL assistant like Claude Code

Project description

SQLSaber

Use the agent Luke!

SQLSaber is an agentic SQL assistant. Think Claude Code but for SQL.

Ask your questions in natural language and it will gather the right context and answer your query by writing SQL and analyzing the results.

Features

  • Natural language to SQL conversion
  • 🔍 Automatic database schema introspection
  • 🛡️ Safe query execution (read-only by default)
  • 🧠 Memory management
  • 💬 Interactive REPL mode
  • 🎨 Beautiful formatted output with syntax highlighting
  • 🗄️ Support for PostgreSQL, SQLite, and MySQL
  • 🔌 MCP (Model Context Protocol) server support

Installation

uv tool install sqlsaber

or

pipx install sqlsaber

Configuration

Database Connection

Set your database connection URL:

saber db add DB_NAME

This will ask you some questions about your database connection

AI Model Configuration

SQLSaber uses Sonnet-4 by default. You can change it using:

saber models set

# for more model settings run:
saber models --help

Memory Management

You can add specific context about your database to the model using the memory feature. This is similar to how you add memory/context in Claude Code.

saber memory add 'always convert dates to string for easier formating'

View all memories

saber memory list

You can also add memories in an interactive query session by starting with the # sign

Usage

Interactive Mode

Start an interactive session:

saber query

You can also add memories in an interactive session by starting your message with the # sign

Single Query

Execute a single natural language query:

saber query "show me all users created this month"

Database Selection

Use a specific database connection:

# Use named database from config
saber query -d mydb "count all orders"

Examples

# Show database schema
saber query "what tables are in my database?"

# Count records
saber query "how many active users do we have?"

# Complex queries with joins
saber query "show me orders with customer details for this week"

# Aggregations
saber query "what's the total revenue by product category?"

# Date filtering
saber query "list users who haven't logged in for 30 days"

# Data exploration
saber query "show me the distribution of customer ages"

# Business analytics
saber query "which products had the highest sales growth last quarter?"

MCP Server Integration

SQLSaber includes an MCP (Model Context Protocol) server that allows AI agents like Claude Code to directly leverage tools available in SQLSaber.

Starting the MCP Server

Run the MCP server using uvx:

uvx saber-mcp

Configuring MCP Clients

Claude Code

Add SQLSaber as an MCP server in Claude Code:

claude mcp add -- uvx saber-mcp

Other MCP Clients

For other MCP clients, configure them to run the command: uvx saber-mcp

Available MCP Tools

Once connected, the MCP client will have access to these tools:

  • get_databases() - Lists all configured databases
  • list_tables(database) - Get all tables in a database with row counts
  • introspect_schema(database, table_pattern?) - Get detailed schema information
  • execute_sql(database, query, limit?) - Execute SQL queries (read-only)

The MCP server uses your existing SQLSaber database configurations, so make sure to set up your databases using saber db add first.

How It Works

SQLSaber uses an intelligent three-step process optimized for minimal token usage:

🔍 Discovery Phase

  1. List Tables Tool: Quickly discovers available tables with row counts
  2. Pattern Matching: Identifies relevant tables based on your query using SQL LIKE patterns

📋 Schema Analysis

  1. Smart Introspection: Analyzes only the specific table structures needed for your query
  2. Selective Loading: Fetches schema information only for relevant tables

⚡ Execution Phase

  1. SQL Generation: Creates optimized SQL queries based on natural language input
  2. Safe Execution: Runs queries with built-in protections against destructive operations
  3. Result Formatting: Presents results with syntax highlighting and explanations

Contributing

Contributions are welcome! Please feel free to open an issue to discuss your ideas or report bugs.

License

This project is licensed under Apache-2.0 License - see the LICENSE file for details.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sqlsaber-0.4.0.tar.gz (75.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sqlsaber-0.4.0-py3-none-any.whl (49.1 kB view details)

Uploaded Python 3

File details

Details for the file sqlsaber-0.4.0.tar.gz.

File metadata

  • Download URL: sqlsaber-0.4.0.tar.gz
  • Upload date:
  • Size: 75.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.7.15

File hashes

Hashes for sqlsaber-0.4.0.tar.gz
Algorithm Hash digest
SHA256 d2cfc71b7ce24d320ff00252615091c347dcfa63e1b85cd0513d54c8a7d98225
MD5 683f81f2a41e5760962adc731f1fd3a3
BLAKE2b-256 2b9eec1d236ba0f9c49eb5496fb7ea45f7470d01c3323c795798b2ea7bcb0244

See more details on using hashes here.

File details

Details for the file sqlsaber-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: sqlsaber-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 49.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.7.15

File hashes

Hashes for sqlsaber-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 225b374fc91a72fa3e517379a32337d88461c58dc77010cdba47919ed9e9e042
MD5 cea1818962112e30b583652e3e3539fd
BLAKE2b-256 b9b3594cf849bf29b6993a257efca5e874aa7481506e62f3a6e37c9efe26457b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page