内容
# SQLite MCP Server
一个使用 TypeScript 实现的模型上下文协议 (Model Context Protocol, MCP) 服务器,用于与 SQLite 数据库进行交互。该服务器提供了一个交互式界面,用于执行 SQL 查询、管理数据库模式以及综合商业洞察——所有这些都在一个可扩展的协议框架内进行。
不熟悉 MCP?请查看下面的 [什么是 MCP?](#whats-an-mcp) 部分。
## 特性
| 命令 | 描述 | 示例 |
|--------------|----------------------------------------|--------------------------------------|
| `read_query` | 在 SQLite 数据库上执行 SELECT 查询 | `SELECT * FROM users WHERE age > 18` |
## 安装与设置
```bash
git clone https://github.com/javsanmar5/mcp-server.sqlite.git
cd mcp-server.sqlite
```
由于该项目尚未作为 npm 包发布,我们将重点介绍 Docker 安装方法:
### 1. 构建 Docker 镜像
```bash
docker build -t mcp/sqlite .
```
### 2. 配置你的 AI 客户端
在你的 AI 客户端配置文件中添加以下内容:
```json
"mcpServers": {
"sqlite": {
"command": "docker",
"args": [
"run",
"--rm",
"-i",
"-v",
"mcp-test:/mcp",
"mcp/sqlite",
"--db-path",
"test_db.sqlite3"
]
}
}
```
如果你不知道这个 json 文件是什么,你可能想查看 [客户端配置指南](#client-configuration-guide)。
### 3. 重启你的 AI 客户端
重启后,MCP 工具应该在你的 AI 客户端界面中可用。
_在 Windows 上,你可能需要手动终止进程以使更改生效。_
## 文档
### 什么是 MCP?
模型上下文协议 (MCP) 是 AI 模型与外部工具和服务交互的标准化方式。它允许 AI 助手执行诸如运行数据库查询、访问外部 API 或通过定义的协议接口操作文件等操作。
MCP 扩展了 AI 的能力,不仅限于对话,通过提供对工具和数据源的结构化访问,而无需直接集成到 AI 模型本身。
### 教程:在 Claude Desktop 上设置
Claude Desktop 是支持 MCP 服务器的众多 AI 客户端之一。以下是在 Windows 上设置的步骤:
1. 按 `Windows Key + R` 打开运行对话框
2. 输入 `%appdata%\Claude` 并按 Enter
3. 如果 `claude_desktop_config.json` 文件不存在,请创建一个新文件
4. 添加上述设置说明第 2 步中的配置
5. 保存文件并重启 Claude Desktop
6. 现在你应该在 Claude 界面中看到可用的 SQLite 工具
## 许可证
该项目采用 MIT 许可证。
## 贡献
该项目主要是为了学习目的而创建的。然而,如果你想贡献,欢迎提交 Pull Request,我会进行审核。
感谢你的关注!