PocketBase MCP Server

项目简介

本项目 'pocketbase-mcp-server' 是一个基于 Model Context Protocol (MCP) 的服务器实现，旨在为大型语言模型 (LLM) 提供访问 PocketBase 数据库的能力。通过此服务器，LLM 可以使用预定义的工具来获取 PocketBase 实例中的数据，例如列出数据库中的集合信息。

主要功能点

• 列出 PocketBase 集合 (pocketbase_list_collections): 允许 LLM 获取 PocketBase 数据库中所有集合的列表，返回 JSON 格式的数据。

安装步骤

1. 安装依赖: 在项目根目录下运行 'npm install' 命令安装项目所需的依赖包。
2. 构建服务器: 运行 'npm run build' 命令编译 TypeScript 代码，生成可执行的 JavaScript 文件。

服务器配置

要将 'pocketbase-mcp-server' 添加到 MCP 客户端（例如 Claude Desktop），您需要配置客户端的服务器配置文件。以下是 Claude Desktop 的配置示例，你需要根据你的 MCP 客户端进行调整。

• Claude Desktop 配置 ( 'claude_desktop_config.json' )

  根据你的操作系统，找到 Claude Desktop 的配置文件位置：

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

  打开或创建 'claude_desktop_config.json' 文件，并添加以下配置信息到 'mcpServers' 字段中：

  {
    "mcpServers": {
      "pocketbase-mcp-server": {
        "command": "/path/to/pocketbase-mcp-server/build/index.js",
        "args": [
          "--pb-url=http://your-pocketbase-url",  // 替换为你的 PocketBase URL，例如 http://localhost:8090
          "--pb-admin-email=your-admin-email",   // 替换为你的 PocketBase 管理员邮箱
          "--pb-admin-password=your-admin-password" // 替换为你的 PocketBase 管理员密码
        ]
      }
    }
  }
  

  配置参数说明:

  • 'command': 指�� 'pocketbase-mcp-server' 服务器可执行文件 'index.js' 的路径。请根据你的实际安装路径进行修改。
  • 'args': 启动服务器时需要传递的参数，用于配置 PocketBase 连接信息：
    • '--pb-url': 你的 PocketBase 实例的 URL 地址。
    • '--pb-admin-email': 用于连接 PocketBase 的管理员邮箱。
    • '--pb-admin-password': 用于连接 PocketBase 的管理员密码。

  注意: 请将 '/path/to/pocketbase-mcp-server/build/index.js' 替换为 'index.js' 文件在你系统中的实际路径，并替换示例配置中的 PocketBase URL、管理员邮箱和密码为你的真实信息。

基本使用方法

1. 启动 MCP 服务器: 配置完成后，MCP 客户端（如 Claude Desktop）应该能够自动启动 'pocketbase-mcp-server'。
2. 在 LLM 中使用工具: 在 LLM 客户端中，你可以指示 LLM 使用 'pocketbase_list_collections' 工具来获取 PocketBase 集合列表。具体的调用方式取决于 LLM 客户端的功能和界面。