README
🚀 SQLite MCP 服务器
一个基于模型上下文协议(MCP)的服务器实现,通过SQLite 提供数据库交互和商业智能功能。该服务器允许运行SQL查询、分析商业数据,并自动生成业务见解备忘录。
🚀 快速开始
本服务器基于模型上下文协议(MCP),借助SQLite实现数据库交互与商业智能功能。你可以运行SQL查询、分析商业数据,还能自动生成业务见解备忘录。
📦 安装指南
- 若尚未安装 Bun,请先进行安装。
- 克隆此仓库。
- 安装依赖:
bun install - 运行设置脚本以在Claude Desktop中配置服务器:
bun run setup
设置脚本会自动将服务器配置添加到您的Claude Desktop配置文件中,该文件位于:
- macOS:
~/Library/Application Support/Claude/claude_desktop_config.json
✨ 主要特性
资源
服务器公开一个动态资源:
memo://insights:一个不断更新的商业见解备忘录,汇总在分析过程中发现的所有见解。随着新见解被append-insight工具发现而自动更新。
提示
服务器提供了一个演示提示:
mcp-demo:交互式提示,指导用户完成数据库操作。- 必需参数:
topic(字符串)- 要分析的商业领域。 - 自动生成适当的数据库模式和样本数据。
- 指导用户进行分析和见解生成。
- 集成到业务见解备忘录中。
- 必需参数:
工具
服务器提供六个核心工具:
查询工具
-
read-query:执行SELECT查询以读取数据。- 输入:
query(字符串):要执行的SELECTSQL 查询。
- 返回:查询结果作为对象数组。
- 输入:
-
write-query:执行INSERT、UPDATE或DELETE查询。- 输入:
query(字符串):SQL 操作查询。
- 返回:
{ affected_rows: number }。
- 输入:
-
create-table:创建新表。- 输入:
query(字符串):CREATE TABLESQL 语句。
- 返回:确认表创建。
- 输入:
模式工具
-
list-tables:获取数据库中所有表的列表。- 无需输入。
- 返回:表名数组。
-
describe-table:查看特定表的模式信息。- 输入:
table_name(字符串):要描述的表名称。
- 返回:列定义数组,包含名称和类型。
- 输入:
分析工具
append-insight:将新的业务见解添加到备忘录资源中。- 输入:
insight(字符串):从数据分析中发现的商业见解。
- 返回:确认见解已添加。
- 触发
memo://insights资源更新。
- 输入:
📚 详细文档
项目结构
src/index.ts:主服务器实现文件。src/logger.ts:日志实用工具。scripts/setup.ts:Claude Desktop 配置脚本。
日志记录
服务器维护详细的日志:
server.log:位于项目根目录中。- 日志包含时间戳、日志级别(
DEBUG、INFO、WARN、ERROR、FATAL)和结构化元数据。
数据库
SQLite 数据库文件位置为:
data.sqlite:位于项目根目录中。若不存在,将自动创建。
可用脚本
bun run setup:配置服务器。bun run dev:以开发模式运行。bun run build:构建项目。bun run lint:检查代码风格。
📄 许可证
此项目的许可证遵循 MIT 协议。有关详细信息,请参阅 LICENSE 文件。
Scan to contact