使用说明
项目简介
SQLite MCP Server 是一个基于 Model Context Protocol (MCP) 的后端实现,它利用 SQLite 数据库提供数据交互和业务智能功能。通过此服务器,用户可以执行 SQL 查询、分析业务数据,并自动生成业务洞察备忘录。
主要功能点
- 资源管理: 提供动态资源 'memo://insights',用于持续更新业务洞察备忘录。
- Prompt 模板: 提供 'mcp-demo' 交互式 Prompt,引导用户进行数据库操作和分析。
- 工具集: 提供六个核心工具,包括:
- 'read-query', 'write-query', 'create-table' (SQL 查询工具)
- 'list-tables', 'describe-table' (Schema 工具)
- 'append-insight' (分析工具,用于更新洞察备忘录)
安装步骤
- 安装 Bun: 如果尚未安装,请访问 Bun官网 按照指引安装 Bun。Bun 是一个快速的 JavaScript 运行时和包管理器,用于运行此服务器。
- 克隆仓库: 使用 Git 克隆 'jacksteamdev_mcp-sqlite-bun-server' 仓库到本地。
git clone https://github.com/MCP-Mirror/jacksteamdev_mcp-sqlite-bun-server cd jacksteamdev_mcp-sqlite-bun-server - 安装依赖: 在仓库目录下运行以下命令安装项目依赖。
bun install - 配置服务器: 运行 setup 脚本,将服务器配置添加到 Claude Desktop 的配置文件中。 Claude Desktop 是一款支持 MCP 协议的客户端应用 (根据仓库 'setup.ts' 脚本推断)。
此脚本会自动修改 Claude Desktop 的配置文件 ('claude_desktop_config.json'),通常位于:bun run setup- macOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
服务器配置
要将此 MCP 服务器添加到 MCP 客户端(如 Claude Desktop),您需要提供以下配置信息。此配置通常在客户端的设置或集成菜单中进行配置。
{ "server name": "sqlite-bun", // MCP 服务器的名称,可以自定义 "command": "bun", // 启动服务器的命令,这里使用 bun "args": ["src/index.ts"] // 启动命令的参数,指向服务器入口文件 }
参数注释:
- 'server name': 为服务器指定一个易于识别的名称,例如 "sqlite-bun",方便在客户端中管理和选择。
- 'command': 指定用于启动服务器进程的可执行文件,这里是 'bun',确保您的系统环境变量中 'bun' 命令可用。
- 'args': 一个字符串数组,包含传递给 'command' 的参数。这里 '["src/index.ts"]' 指定了服务器的入口文件。客户端会使用 'bun src/index.ts' 命令来启动 MCP 服务器。
基本使用方法
- 启动 MCP 服务器: 当配置完成后,MCP 服务器会在客户端 (如 Claude Desktop) 尝试连接时自动启动。您也可以在项目根目录下手动运行 'bun run dev' (package.json 中未提供 'dev' script,推测客户端会自动运行配置的 command 和 args 来启动服务器).
- 在 MCP 客户端中使用:
- 打开 Claude Desktop 或其他兼容 MCP 协议的客户端应用。
- 在客户端的 MCP 集成菜单中,您应该能看到名为 "sqlite-bun" 的服务器。
- 选择 "sqlite-bun" 服务器,您可以使用其提供的 Prompt (mcp-demo) 和 Resource (memo://insights) 与 LLM 进行交互,利用 SQL 工具进行数据库操作和分析。
- 使用 'mcp-demo' Prompt 时,需要提供一个业务主题 (topic),Prompt 会引导您完成数据库创建、数据分析和洞察生成的过程。
- 分析过程中产生的业务洞察会自动更新到 'memo://insights' 资源,您可以在客户端中查看和使用该备忘录。
通过以上步骤,您就可以成功安装、配置和使用 SQLite MCP Server,利用其提供的数据库交互和业务智能能力。
信息
分类
数据库与文件