Firestore MCP

🚀 Firestore MCP 服务器

Firestore MCP 服务器是一个能直接与 Google Firestore 交互的 MCP（模型上下文协议）服务器。它借助 Claude Desktop 提供了简洁的接口，可用于创建、读取、更新和删除 Firestore 文档。

✨ 主要特性

• 可在 Firestore 集合中创建文档。
• 能从 Firestore 集合中读取文档。
• 支持更新现有文档。
• 可以删除文档。
• 可使用过滤、排序和限制条件查询文档。
• 能够列出可用集合。

📦 安装指南

1. 安装依赖项：

   npm install
   

2. 构建项目：

   npm run build
   

3. 配置 Claude Desktop： 在 claude_desktop_config.json 中添加以下内容：

   "firestore-mcp": {
     "command": "node",
     "args": [
       "/path/to/firestore-mcp/build/index.js"
     ],
     "env": {
       "GOOGLE_CLOUD_PROJECTS": "project-id"
     }
   }
   

   • 将 args 中的路径替换为实际的 index.js 路径。
   • 在 GOOGLE_CLOUD_PROJECTS 中定义项目 ID 的逗号分隔列表，示例：google-project-id1,google-project-id2，第一个列出的项目是默认项目。
   • 该应用程序期望在 keys 文件夹中找到每个项目的 .json 凭证文件，示例：keys/google-project-id1.json，keys/google-project-id2.json。
   • 确保云服务帐号具有与 Cloud Firestore 交互的适当权限，例如 Cloud Datastore Owner 或更少的权限。

📚 详细文档

可用工具

• getDocument：通过 ID 获取集合中的文档。
• createDocument：在集合中创建新文档。
• updateDocument：更新现有文档。
• deleteDocument：删除文档。
• queryDocuments：使用过滤、排序和限制查询文档。
• listCollections：列出所有可用集合。

💻 使用示例

在 Claude Desktop 中的用法示例

以下是每个工具在 Claude Desktop 中使用的示例：

基础用法

获取文档

获取“users”集合中具有 ID “user123”的文档

创建文档

在“users”集合中创建一个新文档，包含以下数据：
{
  "name": "John Doe",
  "email": "john@example.com",
  "age": 30
}

更新文档

将“users”集合中具有 ID “user123”的文档的年龄更改为 31

删除文档

删除“users”集合中具有 ID “user123”的文档

查询文档

查找所有超过 25 岁的用户，并按名称排序

列出集合

列出所有可用的 Firestore 集合

🔧 技术细节

开发

• 调试模式：npm run dev