使用说明

项目简介

Fireproof JSON Database MCP服务器是一个基于 Model Context Protocol (MCP) 构建的应用后端,它使用 Fireproof 数据库来托管和管理JSON文档集合。该服务器旨在为LLM(如Claude Desktop)提供结构化数据存储和访问能力,使其能够通过工具调用来操作JSON数据库。

主要功能点

  • 多数据库支持: 可以创建和管理多个独立的JSON文档数据库。
  • 基本CRUD操作: 支持在数据库中创建、读取、更新和删除JSON文档。
  • 查询功能: 允许根据文档字段对文档进行排序查询。
  • 云同步: 支持将数据库同步到Fireproof Cloud,方便数据共享和云端管理。
  • 工具集成: 通过MCP协议将数据库操作封装为工具,供LLM客户端调用。

安装步骤

  1. 克隆仓库: 首先,将仓库代码克隆到本地:
    git clone https://github.com/jimpick/mcp-json-db-collection-server
    cd mcp-json-db-collection-server
  2. 安装依赖并构建: 使用npm安装项目依赖并构建项目:
    npm install
    npm build

服务器配置

要将此MCP服务器与MCP客户端(例如Claude Desktop)连接,您需要配置客户端的服务器配置文件。以Claude Desktop为例,配置文件路径如下:

  • MacOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
  • Windows: '%APPDATA%/Claude/claude_desktop_config.json'

在配置文件中,添加或修改 'mcpServers' 部分,配置 'json-db-collections' 服务器。请将 '<base-dir>' 替换为 'mcp-json-db-collection-server' 仓库在您本地的绝对路径。

{
  "mcpServers": {
    "json-db-collections": {
      "command": "<base-dir>/mcp-json-db-collection-server/build/index.js"
    }
  }
}

基本使用方法

配置完成后,启动MCP客户端(如Claude Desktop)。客户端将自动连接到此MCP服务器。您可以通过自然语言指令指示LLM客户端使用该服务器提供的工具来管理JSON数据库。

例如,在Claude Desktop中,您可以像示例对话中那样,使用指令创建数据库、添加文档、查询数据、同步到云端等。

示例指令:

  • 'create a json document database named my_database' (创建名为 my_database 的JSON文档数据库)
  • 'add {"name": "apple", "color": "red"} to my_database' (向 my_database 数据库添加一个JSON文档)
  • 'query docs from my_database sorted by name' (查询 my_database 数据库中的文档,按 name 字段排序)
  • 'sync my_database to cloud' (将 my_database 数据库同步到云端)
  • 'list json document dbs' (列出所有JSON文档数据库)
  • 'delete json document db my_database' (删除名为 my_database 的JSON文档数据库)

请参考仓库 README.md 中的示例对话,了解更详细的使用方法。

信息

分类

数据库与文件