关键词

SQLite数据库查询数据访问工具JSON-RPC

使用说明

项目简介

本项目是一个使用TypeScript开发的MCP服务器，它允许客户端通过MCP协议与SQLite数据库进行交互。当前版本提供了一个工具 'read_query'，用于执行SELECT查询。

主要功能点

  • 基于MCP协议与客户端通信。
  • 提供 'read_query' 工具，允许执行SELECT SQL查询。
  • 使用SQLite数据库作为数据源。

安装步骤

  1. 确保已安装Node.js和npm。
  2. 克隆仓库到本地： 
    git clone https://github.com/javsanmar5/mcp-server.sqlite.git
  3. 进入项目目录： 
    cd mcp-server.sqlite
  4. 安装依赖： 
    npm install
  5. 构建项目： 
    npm run build

服务器配置

MCP客户端需要配置以下信息以连接到此MCP服务器：

{
  "serverName": "sqlite-mcp-server",
  "command": "node",
  "args": ["dist/index.js"]
  // 可选配置：通过设置 DB_PATH 环境变量来指定SQLite数据库文件的路径。
  // 例如，在客户端配置中添加 "env": {"DB_PATH": "~/mydb.sqlite"} (请将 "~/mydb.sqlite" 替换为实际的数据库文件路径)。
  // 如果不设置 DB_PATH 环境变量，数据库文件将在默认位置创建。
}

基本使用方法

  1. 启动MCP服务器：在项目根目录下执行 'node dist/index.js'。
  2. 使用MCP客户端连接到服务器 (根据MCP客户端的使用文档进行配置)。
  3. 客户端可以发送 'ListRootsRequest' 请求获取服务器提供的工具列表。
  4. 客户端可以使用 'CallToolRequest' 请求调用 'read_query' 工具，并传入包含 SQL 查询语句的参数，执行数据库查询操作。查询结果将以 JSON 字符串形式返回。

注意： 当前版本仅实现了基本的SELECT查询功能，更多功能仍在开发中。

信息

分类

数据库与文件

访问项目