通过 SQLAlchemy 实现 MCP Server ODBC

一个轻量级的 MCP (模型上下文协议) 服务器，用于 ODBC，使用 FastAPI、pyodbc 和 SQLAlchemy 构建。此服务器与 Virtuoso DBMS 和其他实现 SQLAlchemy 提供程序的 DBMS 后端兼容。

---

特性

• 获取模式: 从连接的数据库中获取并列出所有模式名称。
• 获取表: 检索特定模式或所有模式的表信息。
• 描述表: 生成表结构的详细描述，包括：
  • 列名和数据类型
  • 可空属性
  • 主键和外键
• 搜索表: 基于名称子字符串过滤和检索表。
• 执行存储过程: 在 Virtuoso 的情况下，执行存储过程并检索结果。
• 执行查询:
  • JSONL 结果格式：针对结构化响应进行了优化。
  • Markdown 表格格式：非常适合报告和可视化。

---

前提条件

1. 安装 uv:

   pip install uv
   

   或者使用 Homebrew:

   brew install uv
   

2. unixODBC 运行时环境检查:

3. 通过运行 odbcinst -j 检查安装配置（即，关键 INI 文件的位置）。

4. 通过运行 odbcinst -q -s 列出可用的数据源名称。

5. ODBC DSN 设置: 为目标数据库配置您的 ODBC 数据源名称 (~/.odbc.ini)。 Virtuoso DBMS 示例：

   [VOS]
   Description = OpenLink Virtuoso
   Driver = /path/to/virtodbcu_r.so
   Database = Demo
   Address = localhost:1111
   WideAsUTF16 = Yes
   

6. SQLAlchemy URL 绑定: 使用以下格式：

   virtuoso+pyodbc://user:password@VOS
   

---

安装

克隆此存储库：

git clone https://github.com/OpenLinkSoftware/mcp-sqlalchemy-server.git
cd mcp-sqlalchemy-server

环境变量

通过覆盖默认值来更新您的 .env 以匹配您的偏好

ODBC_DSN=VOS
ODBC_USER=dba
ODBC_PASSWORD=dba
API_KEY=xxx

---

配置

对于 Claude Desktop 用户： 将以下内容添加到 claude_desktop_config.json：

{
  "mcpServers": {
    "my_database": {
      "command": "uv",
      "args": ["--directory", "/path/to/mcp-sqlalchemy-server", "run", "mcp-sqlalchemy-server"],
      "env": {
        "ODBC_DSN": "dsn_name",
        "ODBC_USER": "username",
        "ODBC_PASSWORD": "password",
        "API_KEY": "sk-xxx"
      }
    }
  }
}

---

用法

数据库管理系统 (DBMS) 连接 URL

以下是使用此 mcp-server 测试过的用于连接到 DBMS 系统的 pyodbc URL 示例。

数据库	URL 格式
Virtuoso DBMS	virtuoso+pyodbc://user:password@ODBC_DSN
PostgreSQL	postgresql://user:password@localhost/dbname
MySQL	mysql+pymysql://user:password@localhost/dbname
SQLite	sqlite:///path/to/database.db
连接后，您可以通过 Claude 与您的 WhatsApp 联系人互动，在您的 WhatsApp 对话中利用 Claude 的 AI 功能。

提供的工具

概述

name	description
podbc_get_schemas	列出连接的数据库管理系统 (DBMS) 可访问的数据库模式。
podbc_get_tables	列出与选定的数据库模式关联的表。
podbc_describe_table	提供与指定数据库模式关联的表的描述。 这包括有关列名、数据类型、null 处理、自动递增、主键和外键的信息
podbc_filter_table_names	列出基于 q 输入字段中的子字符串模式，与选定的数据库模式关联的表。
podbc_query_database	执行 SQL 查询并以 JSONL 格式返回结果。
podbc_execute_query	执行 SQL 查询并以 JSONL 格式返回结果。
podbc_execute_query_md	执行 SQL 查询并以 Markdown 表格格式返回结果。
podbc_spasql_query	执行 SPASQL 查询并返回结果。
podbc_sparql_query	执行 SPARQL 查询并返回结果。
podbc_virtuoso_support_ai	与 Virtuoso 支持助手/代理交互 -- 一种 Virtuoso 特定的功能，用于与 LLM 交互

详细描述

• podbc_get_schemas

  • 检索并返回连接的数据库中的所有模式名称的列表。
  • 输入参数：
    • user (string, optional): 数据库用户名。默认为 "demo"。
    • password (string, optional): 数据库密码。默认为 "demo"。
    • dsn (string, optional): ODBC 数据源名称。默认为 "Local Virtuoso"。
  • 返回模式名称的 JSON 字符串数组。

• podbc_get_tables

  • 检索并返回包含有关指定模式中的表的信息的列表。 如果未提供模式，则使用连接的默认模式。
  • 输入参数：
    • schema (string, optional): 用于过滤表的数据库模式。默认为连接默认值。
    • user (string, optional): 数据库用户名。默认为 "demo"。
    • password (string, optional): 数据库密码。默认为 "demo"。
    • dsn (string, optional): ODBC 数据源名称。默认为 "Local Virtuoso"。
  • 返回包含表信息的 JSON 字符串（例如，TABLE_CAT、TABLE_SCHEM、TABLE_NAME、TABLE_TYPE）。

• podbc_filter_table_names

  • 过滤并返回有关名称包含特定子字符串的表的信息。
  • 输入参数：
    • q (string, required): 要在表名称中搜索的子字符串。
    • schema (string, optional): 用于过滤表的数据库模式。默认为连接默认值。
    • user (string, optional): 数据库用户名。默认为 "demo"。
    • password (string, optional): 数据库密码。默认为 "demo"。
    • dsn (string, optional): ODBC 数据源名称。默认为 "Local Virtuoso"。
  • 返回包含匹配表信息的 JSON 字符串。

• podbc_describe_table

  • 检索并返回有关特定表的列的详细信息。
  • 输入参数：
    • schema (string, required): 包含该表的数据库模式名称。
    • table (string, required): 要描述的表的名称。
    • user (string, optional): 数据库用户名。默认为 "demo"。
    • password (string, optional): 数据库密码。默认为 "demo"。
    • dsn (string, optional): ODBC 数据源名称。默认为 "Local Virtuoso"。
  • 返回描述表列的 JSON 字符串（例如，COLUMN_NAME、TYPE_NAME、COLUMN_SIZE、IS_NULLABLE）。

• podbc_query_database

  • 执行标准 SQL 查询并以 JSON 格式返回结果。
  • 输入参数：
    • query (string, required): 要执行的 SQL 查询字符串。
    • user (string, optional): 数据库用户名。默认为 "demo"。
    • password (string, optional): 数据库密码。默认为 "demo"。
    • dsn (string, optional): ODBC 数据源名称。默认为 "Local Virtuoso"。
  • 以 JSON 字符串形式返回查询结果。

• podbc_query_database_md

  • 执行标准 SQL 查询并以 Markdown 表格格式返回结果。
  • 输入参数：
    • query (string, required): 要执行的 SQL 查询字符串。
    • user (string, optional): 数据库用户名。默认为 "demo"。
    • password (string, optional): 数据库密码。默认为 "demo"。
    • dsn (string, optional): ODBC 数据源名称。默认为 "Local Virtuoso"。
  • 以 Markdown 表格字符串形式返回查询结果。

• podbc_query_database_jsonl

  • 执行标准 SQL 查询并以 JSON Lines (JSONL) 格式（每行一个 JSON 对象）返回结果。
  • 输入参数：
    • query (string, required): 要执行的 SQL 查询字符串。
    • user (string, optional): 数据库用户名。默认为 "demo"。
    • password (string, optional): 数据库密码。默认为 "demo"。
    • dsn (string, optional): ODBC 数据源名称。默认为 "Local Virtuoso"。
  • 以 JSONL 字符串形式返回查询结果。

• podbc_spasql_query

  • 执行 SPASQL（SQL/SPARQL 混合）查询并返回结果。 这是 Virtuoso 特有的功能。
  • 输入参数：
    • query (string, required): SPASQL 查询字符串。
    • max_rows (number, optional): 要返回的最大行数。 默认为 20。
    • timeout (number, optional): 查询超时时间（毫秒）。 默认为 30000。
    • user (string, optional): 数据库用户名。默认为 "demo"。
    • password (string, optional): 数据库密码。默认为 "demo"。
    • dsn (string, optional): ODBC 数据源名称。默认为 "Local Virtuoso"。
  • 返回来自底层存储过程调用的结果（例如，Demo.demo.execute_spasql_query）。

• podbc_sparql_query

  • 执行 SPARQL 查询并返回结果。 这是 Virtuoso 特有的功能。
  • 输入参数：
    • query (string, required): SPARQL 查询字符串。
    • format (string, optional): 所需的结果格式。 默认为 'json'。
    • timeout (number, optional): 查询超时时间（毫秒）。 默认为 30000。
    • user (string, optional): 数据库用户名。默认为 "demo"。
    • password (string, optional): 数据库密码。默认为 "demo"。
    • dsn (string, optional): ODBC 数据源名称。默认为 "Local Virtuoso"。
  • 返回来自底层函数调用的结果（例如，"UB".dba."sparqlQuery"）。

• podbc_virtuoso_support_ai

  • 利用 Virtuoso 特定的 AI 助手功能，传递提示和可选的 API 密钥。 这是 Virtuoso 特有的功能。
  • 输入参数：
    • prompt (string, required): AI 功能的提示文本。
    • api_key (string, optional): AI 服务的 API 密钥。 默认为 "none"。
    • user (string, optional): 数据库用户名。默认为 "demo"。
    • password (string, optional): 数据库密码。默认为 "demo"。
    • dsn (string, optional): ODBC 数据源名称。默认为 "Local Virtuoso"。
  • 返回来自 AI 支持助手函数调用的结果（例如，DEMO.DBA.OAI_VIRTUOSO_SUPPORT_AI）。

---

故障排除

为了更容易进行故障排除：

1. 安装 MCP Inspector：

   npm install -g @modelcontextprotocol/inspector
   

2. 启动 Inspector：

   npx @modelcontextprotocol/inspector uv --directory /path/to/mcp-sqlalchemy-server run mcp-sqlalchemy-server
   

访问提供的 URL 以对服务器交互进行故障排除。