PocketBase MCP Server

PocketBase MCP Server

site icon
2025.04.11 8
TypeScript数据库管理PocketBase 交互数据库
PocketBase MCP Server 是一个与 PocketBase 实例交互的 MCP 服务器,允许用户获取、列出、创建、更新和管理 PocketBase 集合中的记录和文件。它提供了丰富的记录管理、集合管理和迁移管理功能,适用于需要高效管理数据库内容的场景。
View on GitHub

Overview

基本能力

产品定位

PocketBase MCP Server 是一个数据库管理工具,专注于与 PocketBase 实例的交互,提供记录和文件的管理功能。

核心功能

  1. 记录管理:包括获取、列出、创建、更新记录,以及上传和下载文件。
  2. 集合管理:列出所有集合和获取集合模式。
  3. 迁移管理:创建和应用迁移文件,管理数据库模式变更。

适用场景

  • 需要高效管理 PocketBase 数据库记录和文件的场景。
  • 需要进行数据库模式迁移和版本控制的场景。
  • 需要自动化数据库操作的开发流程。

工具列表

  1. fetch_record:通过 ID 获取单个记录。
  2. list_records:列出集合中的记录,支持分页、过滤、排序和扩展关系。
  3. create_record:在集合中创建新记录。
  4. update_record:更新集合中的现有记录。
  5. get_collection_schema:获取集合的模式。
  6. upload_file:上传文件到集合记录的特定字段。
  7. list_collections:列出 PocketBase 实例中的所有集合。
  8. download_file:获取集合记录中文件的下载 URL。
  9. set_migrations_directory:设置迁移文件的目录。
  10. create_migration:创建新的空迁移文件。
  11. create_collection_migration:创建新集合的迁移文件。
  12. add_field_migration:创建添加字段到现有集合的迁移文件。
  13. list_migrations:列出迁移目录中的所有迁移文件。
  14. apply_migration:应用特定的迁移文件。
  15. revert_migration:回滚特定的迁移文件。
  16. apply_all_migrations:应用所有待处理的迁移。
  17. revert_to_migration:回滚到特定的迁移点。

常见问题解答

  • 如何配置 PocketBase API URL 和 Admin Token? 需要在环境变量中设置 POCKETBASE_API_URLPOCKETBASE_ADMIN_TOKEN
  • 如何安装和运行服务器? 克隆仓库后,运行 npm install 安装依赖,然后运行 npm run build 构建服务器。

使用教程

使用依赖

  1. 确保已安装 Node.js 和 npm。
  2. 克隆仓库: bash git clone <repository_url> cd pocketbase-mcp

安装教程

  1. 安装依赖: bash npm install
  2. 构建服务器: bash npm run build

调试方式

  1. 确保环境变量已正确设置。
  2. 运行服务器: bash node build/index.js
  3. 使用 Cline 工具进行交互和调试。

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。