article
README
🚀 高级 PocketBase MCP 服务器
高级 PocketBase MCP 服务器是一个功能全面的 MCP 服务器,它提供了与 PocketBase 数据库交互的高级工具。通过模型上下文协议(MCP),该服务器能够实现复杂的数据库操作、架构管理和数据处理。
✨ 主要特性
集合管理
- 创建和管理自定义架构的集合。
- 带数据保留的集合迁移。
- 高级索引管理(创建、删除、列出)。
- 架构验证和类型安全。
- 获取集合架构和元数据。
记录操作
- 对记录进行 CRUD 操作。
- 支持过滤器、排序和聚合的高级查询。
- 具备批量导入/导出功能。
- 支持关系扩展。
- 支持分页和游标导航。
用户管理
- 用户身份验证和令牌管理。
- 用户账户创建和管理。
- 密码管理。
- 基于角色的访问控制。
- 会话处理。
数据库操作
- 数据库备份和恢复。
- 支持多种导出格式(JSON/CSV)。
- 提供数据迁移工具。
- 索引优化。
- 批处理操作。
📦 安装指南
- 克隆仓库。
- 安装依赖:
npm install。 - 复制
.env.example到.env并配置。 - 构建:
npm run build。 - 启动你的 PocketBase 实例。
- MCP 服务器将自动连接到你的 PocketBase 实例。
💻 使用示例
可用工具
集合管理
create_collection:创建具有自定义架构的新集合。get_collection_schema:获取集合的架构详细信息。migrate_collection:带数据保留迁移集合架构。manage_indexes:创建、删除或列出集合索引。
记录操作
create_record:在集合中创建新记录。list_records:使用可选过滤器和分页列出记录。update_record:更新现有记录。delete_record:删除记录。query_collection:使用过滤器、排序和聚合进行高级查询。import_data:以创建/更新/插入模式导入数据到集合。
用户管理
authenticate_user:身份验证用户并获取令牌。create_user:创建新用户账户。
数据库操作
backup_database:创建 PocketBase 数据库的备份。import_data:以指定格式导入数据。
📚 详细文档
错误处理
所有工具都包含全面的错误处理,带有详细的错误消息。错误包括:
- 无效请求错误
- 身份验证错误
- 数据库操作错误
- 架构验证错误
- 网络错误
类型安全
该服务器为所有操作提供 TypeScript 定义,确保类型安全。每个工具的输入架构都经过严格的类型检查和验证。
最佳实践
- 总是使用适当的错误处理与 try/catch 块。
- 在执行操作前验证数据。
- 使用适合的索引以提高查询性能。
- 定期备份数据库。
- 对架构变更使用迁移。
- 遵循用户管理的安全最佳实践。
- 监控和优化数据库性能。
🔧 技术细节
贡献
- 叉克仓库。
- 创建功能分支。
- 提交更改。
- 推送到分支。
- 创建 Pull Request。
Scan to contact