English Français العربية

text2sql

السجل الرسمي البيانات وقواعدها

Ask any SQL database in natural language. Agent explores schema, writes SQL, self-corrects.

الشيفرة المصدرية التوثيق

ماذا يمكنك أن تفعل مع text2sql؟

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

التثبيت

أضف هذا إلى إعدادات MCP في عميلك (Claude Desktop: claude_desktop_config.json، وCursor: ‏.cursor/mcp.json، ويستخدم VS Code وغيره الصيغة نفسها «mcpServers»).

PYPI package text2sql-mcp
Claude Code 
claude mcp add text2sql -e 'TEXT2SQL_DATABASE_URL=<TEXT2SQL_DATABASE_URL>' -e 'ANTHROPIC_API_KEY=<your anthropic_api_key>' -e 'OPENAI_API_KEY=<your openai_api_key>' -e 'TEXT2SQL_MODEL=<TEXT2SQL_MODEL>' -- uvx text2sql-mcp==0.1.2
إعداد JSON (Claude Desktop وCursor وVS Code) 
{
    "mcpServers": {
        "text2sql": {
            "command": "uvx",
            "args": [
                "text2sql-mcp==0.1.2"
            ],
            "env": {
                "TEXT2SQL_DATABASE_URL": "<TEXT2SQL_DATABASE_URL>",
                "ANTHROPIC_API_KEY": "<your anthropic_api_key>",
                "OPENAI_API_KEY": "<your openai_api_key>",
                "TEXT2SQL_MODEL": "<TEXT2SQL_MODEL>"
            }
        }
    }
}

متغيرات البيئة

  • TEXT2SQL_DATABASE_URL إلزامي SQLAlchemy connection URL, e.g. sqlite:///mydb.db or postgresql://user:pass@host/db
  • ANTHROPIC_API_KEY سري Anthropic API key (required if using the default Anthropic model)
  • OPENAI_API_KEY سري OpenAI API key (required when TEXT2SQL_MODEL is set to an openai:* model)
  • TEXT2SQL_MODEL Optional LangChain model id (default: anthropic:claude-sonnet-4-6)

التوثيق

مأخوذ من ملف README للمشروع على GitHub ويُحدَّث أسبوعيًا. تفتح الروابط على GitHub.

المحتويات
  1. text2sql-mcp
  2. Install
  3. Configure
  4. Tools
  5. How it works
  6. License

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
Postgresuvx 'text2sql-mcp[postgres]'
MySQLuvx 'text2sql-mcp[mysql]'
Snowflakeuvx 'text2sql-mcp[snowflake]'
BigQueryuvx 'text2sql-mcp[bigquery]'
OpenAI modelsadd openai, e.g. uvx 'text2sql-mcp[postgres,openai]'

Configure

Set environment variables in your MCP client config:

VariableRequiredDescription
TEXT2SQL_DATABASE_URLyesSQLAlchemy URL, e.g. sqlite:///mydb.db, postgresql://user:pass@host/db
ANTHROPIC_API_KEY or OPENAI_API_KEYyesLLM provider key
TEXT2SQL_MODELnoLangChain model id (default: anthropic:claude-sonnet-4-6)
TEXT2SQL_INSTRUCTIONSnoBusiness rules / hints, e.g. "Revenue = net of refunds."
TEXT2SQL_EXAMPLESnoPath 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

الأسئلة الشائعة

ما هو text2sql؟

Ask any SQL database in natural language. Agent explores schema, writes SQL, self-corrects.

كيف أثبّت text2sql؟

يعمل على جهازك. في Claude Code: claude mcp add text2sql -e 'TEXT2SQL_DATABASE_URL=<TEXT2SQL_DATABASE_URL>' -e 'ANTHROPIC_API_KEY=<your anthropic_api_key>' -e 'OPENAI_API_KEY=<your openai_api_key>' -e 'TEXT2SQL_MODEL=<TEXT2SQL_MODEL>' -- uvx text2sql-mcp==0.1.2. وفي العملاء الآخرين، الصق إعداد JSON من هذه الصفحة في إعدادات MCP الخاصة بهم.

هل يحتاج text2sql إلى مفتاح API؟

نعم. يتطلب TEXT2SQL_DATABASE_URL, ANTHROPIC_API_KEY, OPENAI_API_KEY، وتضبطها في إعداداته.

هل text2sql مفتوح المصدر؟

نعم. شيفرته متاحة على GitHub بترخيص MIT.

من يصون text2sql؟

ينشره cpenniman12. يدرجه AI.tn لكنه لا يصونه ولا يوصي به.

من سجل MCP الرسمي. الإدراج ليس توصية: راجع شيفرة الخادم وصلاحياته قبل منحه الوصول إلى بياناتك.