关键词

Text-to-SQL数据库查询SQL执行Schema探索LLM工具

使用说明

项目简介

本项目是一个基于 Model Context Protocol (MCP) 实现的服务器，专注于为 Text-to-SQL 应用场景提供后端支持。它集成了两个关键工具：

  1. 数据库 Schema 查询工具: 允许 LLM 获取数据库的表结构信息，包括表名、列名、数据类型和示例值，帮助 LLM 理解数据库结构。
  2. SQL 执行工具: 允许 LLM 执行 SQL 查询语句，并返回查询结果，实现与数据库的交互。

通过这两个工具，本项目旨在简化和增强 LLM 在 Text-to-SQL 任务中的应用，使 LLM 能够更有效地理解和操作数据库。

主要功能点

  • Schema 查询: 提供工具以结构化的方式返回数据库 Schema 信息，包括表、列、类型和示例数据。
  • SQL 执行: 提供工具来验证和执行 SQL 查询，并返回查询结果或执行状态。
  • 工具注册与调用: 使用 MCP '@tool' 装饰器注册工具，并通过 MCP Inspector 或 MCP 客户端进行调用。
  • 开发模式: 支持使用 'mcp dev' 命令以开发模式快速启动服务器，方便测试和调试。

安装步骤

  1. 安装 Python 依赖: 确保您的环境中已安装 Python，然后使用 pip 安装项目所需的依赖： 
    pip install -r requirements.txt

服务器配置

为了让 MCP 客户端连接到此服务器，您需要提供以下配置信息。这些信息通常配置在 MCP 客户端的应用设置中。

{
  "server name": "SQLite Explorer Server",
  "command": "mcp",
  "args": ["dev", "tool_calling.py"]
}

配置参数说明:

  • '"server name"': 服务器的名称，可以自定义，例如 "SQLite Explorer Server"，用于在 MCP 客户端中标识该服务器。
  • '"command"': 启动 MCP 服务器的命令，这里是 'mcp'，假设您的环境中 'mcp' 命令可用 (通常通过 'pip install mcp-server' 安装)。
  • '"args"': 传递给 'mcp' 命令的参数，'["dev", "tool_calling.py"]' 表示以开发模式运行 'tool_calling.py' 文件，该文件包含了服务器的工具定义。

请注意: 您需要确保已安装 'mcp-server' 库，才能使用 'mcp' 命令。 如果没有安装，请先执行 'pip install mcp-server'。

基本使用方法

  1. 启动服务器: 在安装依赖并配置好环境后，使用以下命令启动 MCP 服务器：

    mcp dev tool_calling.py

    服务器成功启动后，您可以使用 MCP Inspector 或配置好的 MCP 客户端与之交互。

  2. 使用 MCP Inspector 测试 (可选): 如果您安装了 MCP Inspector，可以打开 Inspector 并连接到正在运行的服务器，查看和测试已注册的工具 'fetch_schema' 和 'validate_and_execute_sql_query'。

  3. 在 MCP 客户端中使用: 在您的 MCP 客户端应用中，配置上述服务器配置信息，客户端将能够连接到此服务器，并调用 'fetch_schema' 和 'validate_and_execute_sql_query' 工具，实现 Text-to-SQL 的 agentic workflow。

信息

分类

数据库与文件

访问项目