afgong-sqlite-mcp-server

SQLite Explorer MCP 服务

一个通过模型上下文协议（MCP）为 SQLite 数据库提供安全只读访问的 MCP 服务。此服务使用 FastMCP 框架构建，让大模型能够借助内置的安全功能和查询验证来探索和查询 SQLite 数据库。

📋 系统要求

• Python 3.6+
• SQLite 数据库文件（通过环境变量指定路径）

📦 依赖项

安装所有必需的依赖项：

# Using pip
pip install -r requirements.txt

必需的软件包

• fastmcp：用于构建模型上下文协议服务的框架

所有依赖项都已列在 requirements.txt 中，方便安装。

📑 目录

• 系统要求
• 依赖项
• MCP 工具
• 开始使用
• 安装选项
  • Claude Desktop
  • Cline VSCode 插件
• 安全功能
• 开发文档
• 环境变量

🛠️ MCP 工具

此服务向大模型提供以下工具：

read_query

在数据库上执行 SELECT 查询，并进行内置安全验证。功能包括：

• 查询验证与清理
• 支持参数绑定
• 强制执行行数限制
• 将结果格式化为字典

list_tables

列出数据库中所有可用表的名称。

describe_table

获取特定表的详细架构信息，包括：

• 列名和类型
• NULL 约束
• 默认值
• 主键信息

🚀 开始使用

克隆代码库：

git clone https://github.com/hannesrudolph/sqlite-explorer-fastmcp-mcp-server.git
cd sqlite-explorer-fastmcp-mcp-server

📦 安装选项

你可以将此 MCP 服务安装到 Claude Desktop 或 Cline VSCode 插件中。请选择最适合你需求的选项。

选项 1：安装到 Claude Desktop

使用 FastMCP 安装：

fastmcp install sqlite_explorer.py --name "SQLite Explorer" -e SQLITE_DB_PATH=/path/to/db

将 /path/to/db 替换为 SQLite 数据库文件的路径。

选项 2：安装到 Cline VSCode 插件

要将此服务与 Cline VSCode 插件搭配使用：

1. 在 VSCode 中，点击 Cline 插件侧边栏中的服务图标（☰）
2. 点击“Edit MCP Settings”按钮（✎）
3. 将以下配置添加到设置文件中：

{
  "sqlite-explorer": {
    "command": "uv",
    "args": [
      "run",
      "--with",
      "fastmcp",
      "--with",
      "uvicorn",
      "fastmcp",
      "run",
      "/path/to/repo/sqlite_explorer.py"
    ],
    "env": {
      "SQLITE_DB_PATH": "/path/to/your/database.db"
    }
  }
}

替换：

• /path/to/repo 为克隆此代码库所在位置的完整路径（例如，/Users/username/Projects/sqlite-explorer-fastmcp-mcp-server）
• /path/to/your/database.db 为 SQLite 数据库文件的完整路径

🔒 安全功能

• 以只读方式访问 SQLite 数据库
• 查询验证与清理
• 通过参数绑定安全执行查询
• 强制执行行数限制
• 禁止输出进度信息，以确保 JSON 响应整洁

📚 开发文档

代码库包含用于开发的文档文件：

• mcp-documentation.txt：包含有关 MCP 服务实现和 FastMCP 框架用法的全面文档。

开发功能时，可将此文档作为上下文，也可配合大模型辅助开发。

⚙️ 环境变量

必须设置以下环境变量：

• SQLITE_DB_PATH：要探索的 SQLite 数据库文件的完整路径