使用说明
项目简介
这是一个基于Node.js开发的MCP (Model Context Protocol) 服务器,专门用于管理和操作SQLite数据库。它允许大型语言模型 (LLM) 客户端通过标准化的MCP协议,安全地与SQLite数据库进行交互,执行数据查询、修改、创建表格等操作。该服务器旨在为LLM应用提供可靠的上下文数据访问能力,尤其适用于需要本地数据存储和检索的场景。
主要功能点
- 数据查询 (read_query): 执行SELECT SQL查询,从SQLite数据库中检索数据。仅允许执行读取操作的查询。
- 数据修改 (write_query): 执行INSERT, UPDATE, DELETE SQL查询,修改SQLite数据库中的数据。仅允许执行写入操作的查询。
- 创建表格 (create_table): 执行CREATE TABLE SQL语句,在SQLite数据库中创建新的表格。
- 列出表格 (list_tables): 获取SQLite数据库中所有表格的名称列表。
- 描述表格 (describe_table): 获取指定表格的结构信息,例如列名、数据类型等。
安装步骤
- 安装Node.js和npm: 确保你的计算机上已安装Node.js和npm (Node包管理器)。你可以从 nodejs.org 下载并安装。
- 克隆仓库: 使用git命令克隆该GitHub仓库到本地:
git clone https://github.com/johnnyoshika/mcp-server-sqlite-npx.git cd mcp-server-sqlite-npx - 安装依赖: 在仓库根目录下运行npm命令安装项目依赖:
npm ci - 构建项目: 运行npm命令构建TypeScript代码到JavaScript:
npm run build
服务器配置
MCP服务器是为MCP客户端设计的,你需要将此服务器配置到你的MCP客户端中。以 Claude Desktop 为例,你需要编辑 'claude_desktop_config.json' 文件,添加如下 'mcpServers' 配置。请务必根据你的实际安装路径修改 'command' 和 'args' 中的路径。
{ "mcpServers": { "sqlite": { "command": "/absolute/path/to/npx", // **[必填]** 'npx' 的绝对路径。通常在 Node.js 安装目录下的 bin 文件夹中。例如:'/usr/bin/npx' 或 'C:\Program Files\nodejs\npx.cmd' "args": [ "-y", "mcp-server-sqlite-npx", // **[必填]** 运行 'mcp-server-sqlite-npx' 包,无需修改 "/absolute/path/to/database.db" // **[必填]** 你要操作的 SQLite 数据库文件的绝对路径。例如:'/home/user/mydb.db' 或 'C:\data\my_database.db' ], "env": { // **[可选]** 如果 'npx' 或 'node_modules' 不在系统默认 'PATH' 环境变量中,才需要配置 'env' 字段 "PATH": "/absolute/path/to/executables", // **[可选]** 包含 'npx' 和其他可执行文件的目录,多个路径用冒号分隔。例如:'/usr/local/bin:/usr/bin:/bin' "NODE_PATH": "/absolute/path/to/node_modules" // **[可选]** Node.js 模块的安装路径。例如:'/usr/lib/node_modules' } } } }
注意:
- 请将 '/absolute/path/to/npx' 替换为 'npx' 命令的实际绝对路径。你可以通过在终端运行 'which npx' (Linux/macOS) 或 'where npx' (Windows) 查找。
- 请将 '/absolute/path/to/database.db' 替换为你想要操作的 SQLite 数据库文件的实际绝对路径。如果数据库文件不存在,将会被创建。
- 'env' 字段通常情况下可以省略,除非你的 'npx' 或 Node.js 环境配置比较特殊。
基本使用方法
- 启动服务器: 当 MCP 客户端(例如 Claude Desktop)启动并加载配置后,服务器会自动启动。你也可以在命令行中使用 MCP Inspector 工具测试服务器:
npx @modelcontextprotocol/inspector node dist/index.js /absolute/path/to/database.db - 客户端交互: 在 MCP 客户端中,你可以通过客户端提供的界面或工具,调用服务器提供的各项功能 (Tools)。例如,你可以选择 "read_query" 工具,并输入一个SELECT SQL查询语句,客户端会将请求发送到 MCP 服务器,服务器执行查询并将结果返回给客户端。客户端会将结果展示给你。
信息
分类
数据库与文件