Skip to main content

MCP server for text2sql-framework. Lets any MCP-compatible assistant (Claude Desktop, Cursor, Goose, etc.) ask a SQL database questions in natural language.

Project description

text2sql-mcp

MCP server for text2sql-framework. Plugs into Claude Desktop, Cursor, Goose, or any other MCP-compatible assistant and lets it ask a SQL database questions in natural language.

The agent explores the schema, writes SQL, executes it against the real DB, and self-corrects on errors — no RAG layer, no schema descriptions, no pre-computed embeddings.

Install

Out of the box, text2sql-mcp supports SQLite + Anthropic:

pip install text2sql-mcp
# or
uvx text2sql-mcp

For other databases or LLM providers, install with the matching extra so the right driver gets installed:

You want… Install command
SQLite (default) uvx text2sql-mcp
Postgres uvx 'text2sql-mcp[postgres]'
MySQL uvx 'text2sql-mcp[mysql]'
Snowflake uvx 'text2sql-mcp[snowflake]'
BigQuery uvx 'text2sql-mcp[bigquery]'
OpenAI models add openai, e.g. uvx 'text2sql-mcp[postgres,openai]'

Configure

Set environment variables in your MCP client config:

Variable Required Description
TEXT2SQL_DATABASE_URL yes SQLAlchemy URL, e.g. sqlite:///mydb.db, postgresql://user:pass@host/db
ANTHROPIC_API_KEY or OPENAI_API_KEY yes LLM provider key
TEXT2SQL_MODEL no LangChain model id (default: anthropic:claude-sonnet-4-6)
TEXT2SQL_INSTRUCTIONS no Business rules / hints, e.g. "Revenue = net of refunds."
TEXT2SQL_EXAMPLES no Path to a scenarios.md file for the agent's lookup_example tool

Claude Desktop / Cursor / generic MCP

{
  "mcpServers": {
    "text2sql": {
      "command": "uvx",
      "args": ["text2sql-mcp"],
      "env": {
        "TEXT2SQL_DATABASE_URL": "sqlite:///mydb.db",
        "ANTHROPIC_API_KEY": "sk-ant-..."
      }
    }
  }
}

Goose CLI

goose configure
# Add Extension → Command-line Extension
# Name: text2sql
# Command: uvx text2sql-mcp
# Env: TEXT2SQL_DATABASE_URL, ANTHROPIC_API_KEY

Tools

  • query(question, max_rows=100) — ask the database a natural-language question. Returns {sql, data, error, row_count, tool_calls_made}.

How it works

Under the hood this is a thin wrapper around text2sql-framework, which uses LangChain Deep Agents to do iterative tool-calling against a single execute_sql tool. See the framework README for benchmarks (19/20 on Spider zero-shot across 80 tables) and architecture details.

License

MIT

Project details


Download files

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

Source Distribution

text2sql_mcp-0.1.1.tar.gz (4.3 kB view details)

Uploaded Source

Built Distribution

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

text2sql_mcp-0.1.1-py3-none-any.whl (5.4 kB view details)

Uploaded Python 3

File details

Details for the file text2sql_mcp-0.1.1.tar.gz.

File metadata

  • Download URL: text2sql_mcp-0.1.1.tar.gz
  • Upload date:
  • Size: 4.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for text2sql_mcp-0.1.1.tar.gz
Algorithm Hash digest
SHA256 fc4d3f9feb233e79c3df11e47f3a5b08d2649f7a6554c34df6c9eaff51674e6d
MD5 4adbf7da48106a2d288e74fa8ede01d2
BLAKE2b-256 7462364156f356c6f283d20f4ff1d23dfdc1d6be954a6567a045ad3baea49b35

See more details on using hashes here.

File details

Details for the file text2sql_mcp-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: text2sql_mcp-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 5.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for text2sql_mcp-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 47e049ea34e4b7fccf6b331602a6abb7009ae499e92844c3cf486d85322b3cb8
MD5 c330aad40df346b9878b4c2044c5ea25
BLAKE2b-256 ad925256f830757fe6ca526386176e40747c783a8fc2e1aa4f6c95c666b29792

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