使用说明

项目简介

本项目 'fireproof-storage_mcp-database-server' 是一个基于 Model Context Protocol (MCP) 的服务器示例，它演示了如何使用 Fireproof 数据库构建一个简单的 JSON 文档存储服务。该服务器通过 MCP 协议与 LLM 客户端通信，允许 LLM 客户端通过调用工具来对 JSON 文档进行创建、读取、更新、删除和查询操作。

主要功能点

JSON 文档存储: 使用 Fireproof 数据库作为后端，持久化存储 JSON 文档。
CRUD 操作: 提供创建 (Save)、读取 (Load)、更新 (Update，实际为覆盖保存)、删除 (Delete) JSON 文档的功能。
查询功能: 支持根据文档的任意字段对 JSON 文档进行排序查询。
MCP 工具接口: 通过 MCP 协议的工具 (Tools) 功能，将上述操作暴露给 LLM 客户端，方便 LLM 调用。

安装步骤

安装依赖: 在项目根目录下运行以下命令安装项目依赖：
```
npm install
```
构建项目: 运行以下命令构建项目，生成可执行的 JavaScript 文件：
```
npm build
```

服务器配置

MCP 服务器需要配置到 MCP 客户端中才能使用。以 Claude Desktop 为例，你需要编辑 Claude Desktop 的配置文件 'claude_desktop_config.json'，添加以下服务器配置信息。请注意将 'command' 字段的值替换为 你实际的 'fireproof-storage_mcp-database-server' 项目构建后的 'index.js' 文件的绝对路径。

配置文件路径：

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

配置信息 (json 格式):

{
  "mcpServers": {
    "fireproof": {  // 服务器名称，客户端通过此名称引用
      "command": "/path/to/fireproof-mcp/build/index.js" //  !!! 替换为你的 index.js 文件的实际绝对路径 !!!
    }
  }
}

注意:

'/path/to/fireproof-mcp/build/index.js' 必须替换 为你本地 'fireproof-storage_mcp-database-server' 项目中 'build/index.js' 文件的绝对路径。例如：'/Users/yourusername/Documents/fireproof-storage_mcp-database-server/build/index.js'。
'"fireproof"' 是服务器的名称，你可以在客户端配置中使用这个名称来引用该服务器。

基本使用方法

配置完成后，当 LLM 客户端（如 Claude Desktop）启动时，它将尝试连接到你配置的 MCP 服务器。LLM 可以通过调用预定义的工具来与该服务器交互，例如：

'save_json_doc': 保存 JSON 文档。LLM 需要提供 'doc' 参数，包含要保存的 JSON 对象。
'load_json_doc': 加载 JSON 文档。LLM 需要提供 'id' 参数，指定要加载的文档 ID。
'delete_json_doc': 删除 JSON 文档。LLM 需要提供 'id' 参数，指定要删除的文档 ID。
'query_json_docs': 查询 JSON 文档。LLM 需要提供 'sort_field' 参数，指定用于排序的字段。

LLM 会根据工具的描述和参数schema，自动生成调用这些工具的指令，从而实现与 JSON 文档服务器的交互。你无需手动发送 JSON-RPC 请求，只需在支持 MCP 协议的 LLM 客户端中使用即可。

关键词