开发者文档
Markdown 版基本信息
| 项目 | 内容 |
|---|---|
| Base URL | https://api.mirabase.dev |
| 认证 | Authorization: Bearer mb_live_... |
| OpenAPI | https://api.mirabase.dev/v2/openapi.yaml |
| 面向 Agent 的说明 | https://api.mirabase.dev/llms.txt |
| SDK | TypeScript:npm install https://mirabase.io/sdk/mirabase-sdk-0.3.0-rc.1.tgz;Python:pip install https://mirabase.io/sdk/mirabase-0.3.0rc1-py3-none-any.whl |
| Markdown 版 | 每一页的地址后面加 .md 就是它的 Markdown 版,给 Agent 读。全部页面的目录在 llms.txt,全部指南合成一个文件在 llms-full.txt。 |
能力状态
| 能力 | 状态 |
|---|---|
| API Key、主体、Space 和成员 | 已实现 |
| 文件、目录树、批量写入、大文件上传 | 已实现 |
| Entry、版本、回滚、处理状态、彻底删除 | 已实现 |
| 变更流 | 已实现 |
| 用量、限制、审计 | 已实现 |
| 复制、版本对比、来源、下载地址 | 已实现 |
| 读取与写入根路径、提案与审核 | 已实现 |
| 子树异步任务、大合并 | 已实现 |
| 检索、上下文、带引用回答 | 已实现 |
| 记忆 | 已实现 |
| 离线整理(部署可选):休眠与唤醒、整理提案与批准、整理报告、撤销、MEMORY.md 索引、RECENT.md | 已实现 |
| 分支、检查点、合并 | 已实现 |
| 快照、Webhook、导出与导入 | 已实现 |
| 复刻 Space、取消任务、列出副本 | 即将上线 |
| CLI:挂载、Git 工作区 | 即将上线 |
文档目录
- 5 分钟快速开始按路径写入和读取文件,编辑后查看版本,对比并回滚;让 Agent 在分支上修改后合并;获取引用到文件版本的回答;通过 MCP 连接 Agent。
- 认证与 API Key发送、创建、限定、轮换和吊销 API Key。
- SDK安装和配置 TypeScript 与 Python 客户端,并了解它们替你处理的 Space 选择、流式回答、错误、重试和分页。
- 核心概念API 背后的数据模型:Space、Entry 与版本、文件、知识、记忆、分支和访问控制。
- 术语表文档中反复出现的术语,每个用一句话定义,并链接到讲解它的页面。
- 文件与版本写入、读取、编辑和整理文件,比较和回滚版本,处理 Agent 的提案。
- 处理进度文件写入后先变为可检索,记忆随后生成:等待单个文件可检索、跟踪批量导入进度,并识别检索时尚未处理完成的内容。
- 同步、快照与导出用目录树、变更流和 Webhook 将 Space 同步到其他系统,用快照固定某一时刻,用导出和导入迁移整个 Space。
- 检索与上下文由调用方选择来源的 search、由服务选择来源并分配预算的 context,以及带引用的 answer。
- 记忆写入、提炼、审核、更正和遗忘记忆,以及离线整理记忆。
- 连接 Agent(MCP)通过 MCP 将 Claude Code、Codex 等 Agent 接入 Mirabase:连接方式、协议版本、可用的工具及其参数,以及推荐的调用顺序。
- 框架集成即将上线在 Vercel AI SDK、LangChain、LlamaIndex、OpenAI Agents SDK、Mastra 和 CrewAI 中使用 Mirabase 的工具、记忆和检索。
- 分支与挂载面向 Agent 的写时复制工作区、FUSE 挂载、同步命令和 Git 工作区。
- 权限主体、能力、Space 角色、读写根路径和 API Key 的限制如何共同决定一次请求。
- API 约定所有接口共用的规则:请求与响应、请求 id、版本、分页、幂等、条件请求、任务、错误、重试和限流。
- 错误码API Key 可能收到的每个错误码,及其 HTTP 状态码、remediation.action、含义和 Retry-After。
- 技能(Skills)Mirabase 官方技能:告诉 Agent 何时调用哪个 MCP 工具、按什么顺序、哪些操作先征得用户同意。包括九个按任务划分的技能,以及项目记忆和带引用知识库两个完整场景。
- 基于 Mirabase 开发SDK、MCP、技能、Space 中的技能、Webhook 和供应商插件各自的作用与组合方式;一个应用的核心调用流程;如何编写并检查自己的技能。
- 完整 API 参考全部接口、参数和数据结构,从 OpenAPI 规格生成。
