article
README
🚀 SQLite-Anet-MCP 服务器
本项目是基于 Model Control Protocol (MCP) 的 Rust 实现,它借助标准化协议为用户提供访问 SQLite 数据库的功能。通过该服务器,AI 代理能够直接对 SQLite 数据库进行创建、管理和查询等操作。
该项目参考了 Model Context Protocol SQLite Server 的实现。
🚀 快速开始
配置要求
- Rust 需 1.70 及以上版本。
- 需要运行中的 NATS 服务器(可本地运行或通过网络访问)。
- SQLite 作为 Rust 依赖项包含在内。
安装
克隆仓库并构建服务器:
git clone https://github.com/yourusername/sqlite-anet-mcp.git
cd sqlite-anet-mcp
在环境中配置变量,创建一个 .env 文件:
NATS_SERVER=nats://localhost:4222
SQLITE_DB=path/to/your/database.db
启动
运行服务器:
cargo run --release
访问工具接口:http://localhost:8080
测试
- 启动 NATS 服务器。
- 运行测试脚本:
cargo test
- 使用示例请求进行交互。
✨ 主要特性
- 🗃️ 可创建和管理 SQLite 数据表。
- 🔍 能执行 SELECT 查询以检索数据。
- ✏️ 可执行 INSERT、UPDATE 和 DELETE 查询以操作数据。
- 📊 能描述表结构并列出可用表。
- 📝 可保存和综合业务洞察。
- 🔄 采用 NATS 传输层进行消息传递。
- 🛠️ 兼容 JSON-RPC 2.0 API。
- ⚡ 使用 Tokio 实现异步请求处理。
📦 安装指南
克隆仓库
git clone https://github.com/yourusername/sqlite-anet-mcp.git
cd sqlite-anet-mcp
配置环境变量
创建一个 .env 文件:
NATS_SERVER=nats://localhost:4222
SQLITE_DB=path/to/your/database.db
💻 使用示例
示例请求
{
"method": "query_data",
"params": {
"table": "users",
"columns": ["id", "name", "email"],
"conditions": []
}
}
响应示例
{
"status": "success",
"data": [
{ "id": 1, "name": "Alice", "email": "alice@example.com" },
{ "id": 2, "name": "Bob", "email": "bob@example.com" }
]
}
📚 详细文档
可用工具
数据库操作工具
create_table:创建新表。query_data:执行自定义查询。insert_data:插入数据记录。update_record:更新指定记录。delete_record:删除指定记录。
业务洞察资源
business_insights:生成和管理业务洞察报告。
开发指南
添加新功能
若要扩展服务器的功能,可按以下步骤操作:
- 在
src/models/sqlite.rs中定义响应结构。 - 在
src/tools/文件夹中实现工具,遵循 Tool 特性。 - 在
src/main.rs中注册新工具。
故障排除
- 确保 NATS 服务器正在运行且可访问。
- 检查 SQLite 数据库路径是否正确设置。
- 验证请求格式与每个工具的输入模式匹配。
📄 许可证
本项目采用 MIT License。
致谢
该项目基于 Anet MCP Server 框架,并参考了 Model Context Protocol SQLite Server 的实现。
微信扫一扫