SQLite数据库探索服务器

一个基于FastMCP框架的MCP服务器,提供安全、只读的SQLite数据库访问,支持查询验证和表结构查看。

  • by hannesrudolph
  • Python
  • 本地部署
  • 108 星标
  • 更新于
在 GitHub 查看 hannesrudolph/sqlite-explorer-fastmcp-mcp-server

使用说明

SQLite资源管理器MCP服务器

一种MCP服务器,通过模型上下文协议(MCP)提供对SQLite数据库的安全、只读访问。该服务器采用FastMCP框架构建,使LLM能够探索和查询具有内置安全功能和查询验证的SQLite数据库。

📋 系统要求

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

📦 依赖项

安装所有必需的依赖项:

# Using pip
pip install -r requirements.txt

所需套餐

  • fastmcp:构建模型上下文协议服务器的框架

所有依赖关系都在中指定 requirements.txt 便于安装。

📑 目录

🛠️ MCP工具

服务器向LLM公开以下工具:

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

📦 安装选项

您可以在Claude Desktop或Cline VSCode插件中安装此MCP服务器。选择最适合您需求的选项。

选项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. 点击“编辑MCP设置”按钮(✎)
  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框架使用的全面文档。

本文档在开发功能时用作上下文,可以与LLM一起使用以协助开发。

⚙️ 环境变量

必须设置以下环境变量:

  • SQLITE_DB_PATH:要浏览的SQLite数据库文件的完整路径