返回 MCP 目录
public公开dns本地运行

SQLite Database

一个基于TypeScript的SQLite数据库交互MCP服务器实现

article

README

🚀 SQLite MCP 服务器

本项目是一个采用 TypeScript 实现的 Model Context Protocol (MCP) 服务器,专门用于与 SQLite 数据库进行交互。它提供了一个交互式界面,能让用户执行 SQL 查询、管理数据库架构,还能合成商业洞察,且这一切都在一个可扩展的协议框架内完成。若您不了解 MCP,可查看下方的“什么是 MCP?”部分。

✨ 主要特性

| 属性 | 详情 | |------|------| | 主要功能 | 本服务器可列出 SQLite 数据库中的所有表,还能在数据库上执行 SELECT 查询。 |

| 命令 | 描述 | 示例 | |------|------|------| | list_tables | 列出 SQLite 数据库中的所有表 | - | | read_query | 在 SQLite 数据库上执行 SELECT 查询 | SELECT * FROM users WHERE age > 18 |

📦 安装指南

git clone https://github.com/javsanmar5/mcp-server.sqlite.git
cd mcp-server.sqlite

由于此项目尚未作为 npm 包发布,我们将专注于 Docker 安装方法:

1. 构建 Docker 镜像

docker build -t mcp/sqlite .

2. 配置您的 AI 客户端

将以下内容添加到您的 AI 客户端配置文件中:

"mcpServers": {
  "sqlite": {
    "command": "docker",
    "args": [
      "run",
      "--rm",
      "-i",
      "-v",
      "mcp-test:/mcp",
      "mcp/sqlite",
      "--db-path",
      "test_db.sqlite3"
    ]
  }
}

⚠️ 重要提示

如果您不知道这是什么 JSON 文件,可能需要查看“使用教程:与 Claude Desktop 设置”部分。

3. 重启您的 AI 客户端

重启后,MCP 工具应在您的 AI 客户端界面中可用。

💡 使用建议

在 Windows 上,您可能需要手动终止进程才能使更改生效。

📚 详细文档

什么是 MCP?

Model Context Protocol (MCP) 是一种标准化方法,用于 AI 模型与外部工具和服务交互。它允许 AI 助手执行操作,例如运行数据库查询、访问外部 API 或文件操作,通过一个定义的协议接口,而无需将这些功能直接集成到 AI 模型中。

MCP 扩展了 AI 的能力,使其超越对话,提供对工具和数据源的结构化访问,而无需直接整合到 AI 模型本身。

教程:与 Claude Desktop 设置一起使用

Claude Desktop 是支持 MCP 服务器的一种 AI 客户端。以下是 Windows 上的设置方法:

  1. 按下 Windows Key + R 打开运行对话框
  2. 输入 %appdata%\Claude 并按回车
  3. 如果不存在,请创建一个名为 claude_desktop_config.json 的新文件
  4. 添加步骤 2 中设置说明中的配置
  5. 保存文件并重启 Claude Desktop
  6. 您现在应该在 Claude 界面中看到 SQLite 工具

📄 许可证

此项目根据 MIT 许可证发布。

贡献

该项目主要为了学习目的而创建。但是,如果您希望贡献,请提交一个拉取请求,我会审查它。

感谢您的兴趣!

help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端