使用说明

项目简介

本项目是一个 MCP (Model Context Protocol) 服务器 的实现，它允许大型语言模型 (LLM) 客户端通过标准化的 MCP 协议与 SQLite 数据库进行交互。该服务器提供了一系列工具，使 LLM 能够执行 SQL 查询、分析数据，并生成业务洞察报告。您可以将其集成到支持 MCP 协议的 LLM 客户端（如 Claude Desktop）中使用，以扩展 LLM 的数据访问和分析能力。

主要功能点

资源管理: 提供名为 'memo://insights' 的动态资源，作为一个持续更新的业务洞察备忘录，汇总数据分析过程中的发现。
Prompt 模板: 提供 'mcp-demo' 交互式 Prompt，引导用户进行数据库操作和分析，支持自定义分析主题。
工具集: 内置六个核心工具，涵盖 SQL 查询、数据库 Schema 查看和业务洞察记录：
- Query 工具:
  - 'read-query': 执行 'SELECT' 查询，读取数据库数据。
  - 'write-query': 执行 'INSERT', 'UPDATE', 'DELETE' 查询，修改数据库数据。
  - 'create-table': 创建新的数据库表。
- Schema 工具:
  - 'list-tables': 获取数据库中所有表的列表。
  - 'describe-table': 查看指定表的 Schema 信息。
- Analysis 工具:
  - 'append-insight': 将新的业务洞察添加到 'memo://insights' 资源中。

安装步骤

安装 Bun: 如果尚未安装 Bun，请先安装 Bun (一个快速的 JavaScript 运行时和包管理器)。
克隆仓库: 将 GitHub 仓库 'https://github.com/jacksteamdev/mcp-sqlite-bun-server' 克隆到本地。
安装依赖: 在仓库根目录下运行命令 'bun install' 安装项目依赖。
运行配置脚本: 在仓库根目录下运行命令 'bun run setup'，该脚本会自动将服务器配置添加到 Claude Desktop 的配置文件中。

服务器配置

对于 Claude Desktop 等 MCP 客户端，本项目提供了一个便捷的配置脚本 'bun run setup'。运行此脚本后，服务器配置将自动添加到 Claude Desktop 的配置文件中，通常位于：

macOS: '~/Library/Application Support/Claude/claude_desktop_config.json'

您无需手动编辑配置文件。'setup' 脚本会添加类似以下的配置信息（仅供参考，请勿手动修改，除非您了解其含义）：

{
  "mcpServers": {
    "sqlite-bun": {
      "command": "bun",  // 启动服务器的命令，这里使用 bun 运行时
      "args": ["path/to/repo/src/index.ts"] // 启动命令的参数，指向服务器主文件
    }
  }
}

其中 'path/to/repo/src/index.ts' 会被 'setup' 脚本自动替换为正确的服务器主文件路径。

基本使用方法

启动服务器: 虽然 'setup' 脚本配置了 Claude Desktop，但服务器本身是在需要时由 Claude Desktop 启动的。您无需手动启动服务器。
在 Claude Desktop 中使用:
- 打开 Claude Desktop 应用。
- 确保已正确安装并配置 MCP 服务器。
- 在 Claude Desktop 中，您应该能看到 "sqlite-bun" 集成选项。
- 选择 "mcp-demo" Prompt，并提供一个分析主题，即可开始与 SQLite 数据库进行交互式分析。
- 您可以使用自然语言指示 Claude 执行 SQL 查询、创建表、查看数据等操作。
- 分析过程中产生的业务洞察将自动更新到 'memo://insights' 资源，您可以在 Claude Desktop 的附件菜单中找到并查看 "Business Insights Memo"。

通过本 MCP 服务器，您可以利用 LLM 的自然语言理解能力，更方便地进行 SQLite 数据库的数据分析和业务洞察挖掘。

关键词