本项目是一个遵循 Model Context Protocol (MCP) 标准的服务器实现,专为需要与 SQLite 数据库交互的 LLM 应用设计。它将复杂的数据库操作封装为 LLM 可以理解和调用的标准化工具。

主要功能点:

  • 数据库探索: 获取连接的 SQLite 数据库信息,列出所有用户表,查看表的详细结构(列信息)。
  • 数据操作 (CRUD): 提供标准的创建 (Create)、读取 (Read)、更新 (Update)、删除 (Delete) 记录的工具,使 LLM 能够直接管理数据库中的数据。
  • 自定义 SQL 查询: 允许执行任意 SQL 查询,提供了高度的灵活性。

安装步骤:

  1. 确保您的系统安装了 Node.js 和 npm(通常随 Node.js 一起安装)。
  2. 本项目通常通过 npx 直接执行,无需全局安装。

服务器配置:

此 MCP 服务器是供 MCP 客户端(如支持 MCP 的 IDE 或其他应用)使用的。您需要在客户端的 MCP 服务器设置中添加本服务器的配置信息。配置通常是一个 JSON 对象,包含服务器名称、启动命令和参数。

配置示例如下(请根据您的客户端界面填写对应字段):

  • 服务器名称 (Server Name): 例如 "MCP SQLite Server"
  • 启动命令 (Command): 'npx'
  • 参数 (Args):
    • 第一个参数: '-y' (用于同意安装 npx 包)
    • 第二个参数: 'mcp-sqlite' (指定要执行的包)
    • 第三个参数: '<您的 SQLite 数据库文件路径>' (这是必需的参数,指向服务器将要连接和操作的 SQLite 数据库文件,请替换为您实际的文件路径)

配置完成后,MCP 客户端将能够启动此服务器并与之通信。

基本使用方法:

配置并启动服务器后,与您连接的 LLM 客户端(如编程 IDE 中的 AI 助手)将自动获得与 SQLite 数据库交互的能力。LLM 可以通过调用服务器注册的工具(如 'list_tables', 'read_records', 'query' 等)来获取数据库信息、查询数据或执行其他数据库操作,而无需您手动编写数据库代码。您可以直接向 LLM 提出与数据库相关的请求,LLM 会利用这些工具完成任务。

信息

分类

数据库与文件