Open Brain扩展开发指南：如何快速创建、部署并提交你自己的Extension

Open Brain扩展开发指南如何快速创建、部署并提交你自己的Extension【免费下载链接】OB1Open Brain — The infrastructure layer for your thinking. One database, one AI gateway, one chat channel — any AI plugs in. No middleware, no SaaS.项目地址: https://gitcode.com/gh_mirrors/ob/OB1Open BrainOB1是一个去中心化的 AI 记忆基础设施一个数据库 一个 AI 网关 一个聊天渠道任何 AI 都能即插即用无需中间件、无需 SaaS。本指南面向新手带你走完Open Brain 扩展开发的完整流程从零创建自己的 Extension、部署到云端 MCP 服务器再到向社区提交开源贡献——只需 5 个步骤。什么是 Open Brain ExtensionExtension扩展是 Open Brain 生态中「渐进式学习路径」的载体每一个 Extension 都是一个完整的小应用包含数据库表、MCP 服务器代码和分步教程用来给 AI 增加一项新的生活能力。官方已经内置了 6 个按难度递进的 Extension详见 extensions/README.md你可以把它理解为「学习范本」#Extension能做什么难度1Household Knowledge Base家里的所有事实AI 随问随答入门2Home Maintenance Tracker家居保养的计划与历史记录入门3Family Calendar多人日程协调进阶4Meal Planning食谱、周餐计划、共享购物清单进阶5Professional CRM人脉管理与你的想法互相打通进阶6Job Hunt Pipeline求职申请与面试流程跟踪高级 关键特性扩展是可叠加的。你的 CRM 能感知你记录的想法你的餐食计划会检查本周谁在家——这就是扩展生态的复利效应。动手前了解一个 Extension 的「5 件套」每个 Extension 就是一个文件夹如extensions/your-extension/包含固定 5 个文件。官方为 AI 助手准备了一份机器可读的生成规范 AGENT_SPEC.md你也可以直接参照它手工编写文件作用一句话理解README.md人类可读的安装指南教别人怎么用的说明书metadata.json结构化元数据给自动化系统看的身份证schema.sqlPostgreSQL 表结构你的数据存在哪index.tsMCP 服务器代码AI 能调用的工具集deno.json依赖导入映射服务器要装哪些包 想要起点直接从官方模板复制一份 extensions/_template/里面还包含详细的格式规范注释步骤徽章、验证检查点、SQL 折叠块等。步骤 1搭建好 Open Brain 基础环境开发 Extension 前你需要一个能正常运行的 Open Brain 实例。跟着官方入门指南 docs/01-getting-started.md 完成搭建确保你手上有✅ 已安装并链接好项目的Supabase CLI✅ 一张「凭证跟踪表」Project URL、Secret key、Project ref✅ 一个可对话的 AI 客户端Claude Desktop、ChatGPT、Claude Code 均可步骤 2创建你的 Extension 五件套以宠物养护记录扩展为例你需要依次准备 5 个文件1️⃣schema.sql— 设计数据表在 Supabase SQL Editor 中运行建表语句。每张表都要有id、user_id并启用RLS行级安全策略保证每个用户只能看到自己的数据。参考 household-knowledge 的 schema 就能看到标准的写法模式。⚠️必做新增表后必须手动GRANT权限给service_role否则 MCP 服务器会报 permission denied。2️⃣index.ts— 编写 MCP 工具这是 AI 真正调用的工具。每个工具 名字 描述 参数定义 数据库操作例如官方的add_household_item工具定义见 index.ts。新手只需模仿现有 Extension 的写法即可。安全规范只读工具必须标注readOnlyHint: true写入工具要标注readOnlyHint: false等注解——自动化审查会检查这一点。3️⃣metadata.json— 填写元数据必填字段包括name、description、category、author、version、requires.open_brain: true、tags、difficulty、estimated_time。完整示例见 CONTRIBUTING.md。4️⃣deno.json— 依赖映射绝大多数扩展直接复用官方模板里的那份内容即可只有引入额外依赖时才需要修改。5️⃣README.md— 编写安装指南必须包含功能说明、前置条件、分步指令、预期结果、故障排查。Extension 还要求额外包含Why This Matters从一个真实生活痛点讲起、学习路径表格和跨扩展集成说明。步骤 3一键部署为云端 MCP 服务器Open Brain 的扩展不跑在本地而是统一部署为 Supabase Edge Function——部署一次任何 AI 客户端都能连接这就是 Remote MCP 模式。跟着 primitives/deploy-edge-function/ 指南核心就 4 条命令建函数目录supabase functions new your-extension-mcp放入代码把index.ts和deno.json放进函数目录设置密钥生成一个 64 位访问密钥supabase secrets set MCP_ACCESS_KEY...部署上线supabase functions deploy your-extension-mcp --no-verify-jwt✅完成标志supabase functions list中你的函数显示为ACTIVE你的 MCP 连接 URL 形如https://你的项目ref.supabase.co/functions/v1/your-extension-mcp?key你的密钥。步骤 4连接 AI 客户端并测试按 primitives/remote-mcp/ 指南把你的连接 URL 粘贴到任意 AI 客户端客户端连接方式Claude DesktopSettings → Connectors → 添加自定义连接器粘贴 URLChatGPT开启 Developer Mode 后在 Apps Connectors 中创建Claude Code一条claude mcp add命令Cursor在mcp.json中加一个url字段验证测试在 AI 对话里用自然语言试 2~3 个你定义的工具确认数据真的写进了数据库。遇到 401 错误先核对?key后面的密钥是否与 Supabase 中的一致。步骤 5提交你的开源贡献 Extensions 属于Curated精选类别——提交前建议先与维护者讨论并确认你的扩展已在自己的 Open Brain 实例上跑通。提交规范见 CONTRIBUTING.mdPR 标题格式[extensions] 你的扩展短描述PR 描述必写功能说明、依赖的服务/工具、以及已在自己的实例上测试通过的确认审查流程自动化检查文件结构、元数据合法性、无密钥泄露、SQL 安全等 16 条规则→ 通过后人工审查通常 2~5 个工作日常见被拒原因包含 API 密钥或秘密、依赖无免费替代的付费服务、文档不完整、修改了核心thoughts表结构 你的名字将出现在metadata.json的 author 字段和 CONTRIBUTORS.md 中——不写代码也能贡献提一个想法 issue社区导师会帮你实现你仍是第一作者。常见问题速查 ️问题解决方法插入数据报 permission denied漏了GRANT步骤回补授权 SQL部署报 import 错误确认deno.json放在了函数目录而不是项目根目录AI 里看不到工具检查连接器是否在当前对话中启用首次调用很慢Edge Function 冷启动正常现象后续调用会快更多排障见 primitives/troubleshooting/。写在最后从一张表到 AI 随手可用一个 Open Brain Extension 的开发周期远比你想象的短。建议路径通读 extensions/household-knowledge/最简范本复制模板做出你的第一个扩展部署、连接、测试跑通闭环开 issue 讨论 → 提交 PR → 进入贡献者阶梯另外提醒每加一个扩展AI 上下文里的工具数就会增加。工具多了之后记得参考 MCP 工具审计指南 定期给工具做体检让 AI 始终精准选对工具。祝你构建顺利【免费下载链接】OB1Open Brain — The infrastructure layer for your thinking. One database, one AI gateway, one chat channel — any AI plugs in. No middleware, no SaaS.项目地址: https://gitcode.com/gh_mirrors/ob/OB1创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考