普鲁里布斯
普鲁里布斯 是 开放式控制平面 对于受控AI内存: Postgres支持 耐用的行, 情境型召回, 变更前执行,以及 策展--而不将聊天或日志视为事实的来源。
召回 是的名字 模式与学说 这个存储库体现了(约束、决策、模式、失败以及在任何单个会话之后持续的相关类型)。普鲁里布斯是 可运行服务-中描述的HTTP API、MCP、共享全局内存池 docs/memory-doctline.md.
用途: Pluribus仅在代理程序执行时积累内存 每次实质性通行证都要运行它.\ 默认循环:recall_context→ plan → act →record_experience.\ 跳过回忆或跳过记录,你们就不会有持久的进步——就像健忘症一样。
新来的? 三个步骤: docs/get-started.md.
______________________________________________________________________
目录
- 开始使用(新用户)
- 这是什么
- 为什么要用它
- 将Pluribus与AI代理结合使用
- 确保您的代理使用Pluribus
- 将Pluribus与AI编辑器和代理系统结合使用
- 自定义代理的SDK(Go+Python)
- 客户端配置MCP
- 多代理共享内存
- 安装路径
- 配置
- 每日API使用量(烟雾)
- 文档地图
- 存储库布局
- 验证和开发
- 贡献
______________________________________________________________________
这是什么
- 一个HTTP API (港口 8123 在默认堆栈中)用于内存生命周期、调用包、执行和相关工作流。
- 基于HTTP的MCP 在
POST /v1/mcp在 相同 基本URL--服务优先MCP 是规范的;stdio MCP仅具有兼容性。 - 全局内存池 在 Postgres (与 pg向量 用于可选的语义检索)。相关性是 标签+检索文本,而不是每个代理的筒仓。
- 回购治理文件 (
constitution.md,active.md,workorders/,evidence/)描述如何 *这* 存储库使用召回;Pluribus是您可以为采用相同纪律的任何代码库或团队运行的引擎。
标准产品型号: docs/memory-doctline.md · 系统形状: docs/architecture.md
______________________________________________________________________
为什么要用它
| 好处 | 它避免了什么 |
|---|---|
| 连续性 | 每次会话都重新推导相同的约束和失败 |
| 共享真相 | 碎片化的“记忆”被困在一个编辑器或一个聊天中 |
| 权威意识召回 | 将所有内容简化为一个相似性分数 |
| 风险编辑前的执行 | 违反既定决定或模式的运输变更 |
| 精心策划的学习 | 促进噪音;循环有利于 已验证, 键入 声明 |
______________________________________________________________________
快速入门(推荐使用Docker)
先决条件: Docker Compose v2, curl (可选: jq).
从 存储库根目录:
docker compose up -d这就开始了 Postgres (pgvector图像), 瑞迪斯,以及 控制平面 上 http://127.0.0.1:8123在启动时,API等待数据库,应用嵌入式基线SQL,并验证核心表。数据保存在 recall_pgdata 音量,直到您将其删除。
检查它是否已启动:
curl -sS http://127.0.0.1:8123/healthz
curl -sS http://127.0.0.1:8123/readyz两者都应该回归 ok 当启动完成时。
下一步——在Pluribus中使用AI代理: 添加MCP(http://127.0.0.1:8123/v1/mcp)在编辑器中,从以下位置粘贴循环 integrations/pluribus-instructions.md (或您平台下的包 integrations/).完整演练: docs/pluribus-quickstart.md §4和 docs/mcp-usage.md. 光标: integrations/cursor/README.md.
完全重置开发数据库 (破坏性): docker compose down -v 然后 docker compose up -d预发布版本假定 新鲜或一次性 Postgres;目前还没有GA级版本的迁移故事——请参阅 安装.md.
______________________________________________________________________
将Pluribus与AI代理结合使用
让每个客户都看到 相同 API基本URL(默认值 http://127.0.0.1:8123).过程是 并发Postgres是共享商店。协议详细信息: docs/mcp-service-first.md.
让记忆成为习惯(不仅仅是连接): docs/integrations/usage.md --行为循环、验证、故障模式——以及 docs/用法/保险代理-usage.md 了解完整的操作细节。
将Pluribus与AI编辑器和代理系统结合使用
Pluribus是MCP第一 对于代理人来说:机构记忆和认知扩展——不是通用的辅助工具。 表征状态转移 仍然是服务、测试和管理边界。
为什么要尽早整合: 回忆和情景摄取在以下情况下效果最佳 默认习惯--看 docs/integrations/README.md 和 docs/memory-doctline.md.
每 integrations/ / 包中包含一个指针 rules.md,在适用的情况下编辑本地模板, integrations/pluribus-instructions.md (规范循环文本), skill.md, README.md,通常 mcp-config.example.json--指令模板, 不要泄露秘密.
光标(完整的“插件”包): integrations/cursor/ 捆绑MCP JSON(mcp-config.json、无认证+LAN示例), pluribus.mdc (单一规范规则)、代理技能、, prompts.md, commands.md, helper/verify-mcp,以及 plugin-plan.md (Cursor实际上支持什么)。更喜欢 用户级 ~/.cursor/mcp.json 和 用户规则 因此Pluribus适用于每个存储库——请参见 integrations/cursor/README.md.
VS代码(实际扩展名): integrations/vscode/extension/ — 回忆背景, 记录体验, 查看学习内容 针对控制平台REST API;资源管理器侧边栏+输出通道。看 integrations/vscode/README.md 和 docs/integrations/vscode.md.
可选身份验证: 如果服务器具有 PLURIBUS_API_KEY 设置,发送 X-API-Key 在HTTP MCP和 headers 在......下面如果未设置,则忽略它们。 docs/authentication.md.
自定义代理的SDK(Go+Python)
如果您正在构建自己的代理运行时,请使用最小的SDK(召回→ work → 记录):
示例:
examples/go/minimal_loop/main.goexamples/python/minimal_loop.py
客户端配置MCP
将这些用作模板;调整计算机的主机、端口和路径。
端点(HTTP MCP): http://127.0.0.1:8123/v1/mcp (JSON-RPC POST).
回退(stdio): 构建 cd control-plane && go build -o pluribus-mcp ./cmd/pluribus-mcp,然后运行二进制文件 CONTROL_PLANE_URL=http://127.0.0.1:8123 (以及 CONTROL_PLANE_API_KEY 当auth打开时)。与HTTP相同的工具;提示/资源仅在服务上使用HTTP。
光标
全球 ~/.cursor/mcp.json 是理想的,因此Pluribus MCP可用于 每 您打开的存储库;使用 本地存储库 .cursor/mcp.json 仅用于覆盖。 光标MCP参考.
首选--HTTP MCP (无本地 pluribus-mcp 二进制):
{
"mcpServers": {
"pluribus": {
"url": "http://127.0.0.1:8123/v1/mcp"
}
}
}带API键 (使用env变量;不要提交机密):
{
"mcpServers": {
"pluribus": {
"url": "http://127.0.0.1:8123/v1/mcp",
"headers": {
"X-API-Key": "${env:PLURIBUS_API_KEY}"
}
}
}
}替代方案--stdio (如果HTTP传输不可用):
{
"mcpServers": {
"pluribus": {
"command": "${workspaceFolder}/control-plane/pluribus-mcp",
"env": {
"CONTROL_PLANE_URL": "http://127.0.0.1:8123",
"CONTROL_PLANE_API_KEY": "${env:PLURIBUS_API_KEY}"
}
}
}
}编辑后重新启动光标。故障排除: docs/mcp-usage.md.
克劳德桌面
配置文件(典型):macOS ~/Library/Application Support/Claude/claude_desktop_config.json,Windows %APPDATA%\Claude\claude_desktop_config.json,Linux ~/.config/Claude/claude_desktop_config.json克劳德通常期望 标准 服务器--点 command 在你的 pluribus-mcp 二进制和集合 CONTROL_PLANE_URL.
{
"mcpServers": {
"pluribus": {
"command": "/absolute/path/to/recall/control-plane/pluribus-mcp",
"env": {
"CONTROL_PLANE_URL": "http://127.0.0.1:8123"
}
}
}
}添加 CONTROL_PLANE_API_KEY 到 env 当服务器使用 PLURIBUS_API_KEY。保存后完全退出并重新打开Claude Desktop。
开爪
OpenClaw从自己的配置中读取MCP设置(通常在 ~/.openclaw/ --确切的文件名和模式取决于您的OpenClaw版本)。使用 标准 图案: command =路径 pluribus-mcp, env.CONTROL_PLANE_URL = http://127.0.0.1:8123 (或你的主人)。如果您的构建文档 远程/SSE/URL MCP服务器,将URL配置为 http://:8123/v1/mcp 和 X-API-Key 启用身份验证时--匹配 HTTP验证 curl 在那里。
开源代码
添加一个 mcp.pluribus 报关进口 opencode.json 在 存储库根目录 或在 ~/.config/opencode/opencode.json: type": "remote", url": "http://127.0.0.1:8123/v1/mcp", oauth": false.何时 PLURIBUS_API_KEY 已在服务器上设置,请添加 headers 和 X-API-Key (例如。 {env:PLURIBUS_API_KEY}).例子: 集成/opencode/mcp-config.example.json.完整指南: docs/integrations/opencode.md. OpenCode MCP服务器.
VS Code、Zed、Windsurf、Claude Code(CLI)
遵循编辑器的MCP面板: 超文本传输协议 → 基础URL http://127.0.0.1:8123,MCP路径 /v1/mcp; 标准 → pluribus-mcp + CONTROL_PLANE_URL.Claude Code通常支持类似于Cursor的存储库级MCP文件;使用相同 超文本传输协议 或 标准 如上所述的块。
工作流程和更深入的文档
推荐的工具订单(地面→ act → 强制执行→ 学习): docs/mcp-usage.md.完整的客户矩阵和边缘案例: docs/mcp-usage.md.
______________________________________________________________________
确保您的代理使用Pluribus
MCP只有在调用工具时才有用。 循环: recall_context → plan → act → record_experience (别名 memory_context_resolve / mcp_episode_ingest).MCP导线 和 安装平台 本地的 规则/ integrations/ /README.md (从 pluribus-instructions.md),加 snippets/context-prime.txt, skill.md。参见 docs/用法/保险代理-usage.md 和 文档/用法/代码片段/.
______________________________________________________________________
多代理共享内存
内存行位于 全局池. 代理人A 能够写出持久的决策和模式; 代理人B (稍后,不同的会话,不同的工具)调用 召回 有重叠 标签 并看到相同的基板--执行 然后可以标记与既定记忆相矛盾的提案。
分步演示(curl): docs/walkthrough-multi-agent.md单代理连续性: docs/walkthrough-single-agent.md.
______________________________________________________________________
安装路径
| 路径 | 何时使用 |
|---|---|
docker compose up -d (回购根) | 默认值 开发者 烟囱;从生成API ./control-plane. |
docker-compose.install.yml +GHCR图像 | 操作员/无Go工具链;set PLURIBUS_IMAGE 每 安装.md. |
| 本地二进制 | cd control-plane && make build && ./controlplane 反对你自己的Postgres——看 安装.md 选项B |
构建详细信息: 构建.md。从源构建图像: make image (参见 安装.md).
______________________________________________________________________
配置
- 撰写(默认): 这
controlplane集装箱用途CONFIG=/config/config.yaml。内置默认值与Compose服务名称匹配(postgres,redis).来源: 控制平面/config/config.yaml. - 本地覆盖(未提交):
control-plane/configs/config.local.yaml被忽视;集CONFIG在主机上运行时转到该路径。看 微笑。. - 环境(构成): 可选的
PLURIBUS_API_KEY对于API密钥验证对象 评论和 docs/authentication.md. - 更深层次的主题 (召回权重、升级门、Redis、证据路径): 控制平面/README.md 和 docs/plurbus-operational-guide.md.
______________________________________________________________________
每日API使用量(烟雾)
相同 创建+召回 流量为 docs/plurbus-quickstart.md §3--使用该部分进行复制粘贴和解释。快速复制:
curl -sS -X POST http://127.0.0.1:8123/v1/memories \
-H 'Content-Type: application/json' \
-d '{"kind":"constraint","authority":9,"statement":"Run tests before deploy.","tags":["demo","release"]}'
curl -sS -X POST http://127.0.0.1:8123/v1/recall/compile \
-H 'Content-Type: application/json' \
-d '{"tags":["demo","release"],"retrieval_query":"deploy safety"}' | jq .路线索引: docs/http-api-index.md.RC1导向的示例: docs/api-contract.md.
______________________________________________________________________
文档地图
| 需要 | 文件 |
|---|---|
| 最小路径(新用户) | docs/get-started.md |
| 集成采用与验证 | docs/integrations/usage.md |
| 教义(最高权威) | docs/memory-doctline.md |
| 审查员/CI护栏 | docs/反回归.md |
| 快速启动 | docs/plurbus-quickstart.md |
| HTTP+MCP路由图 | docs/http-api-index.md |
| 变更前执行 | docs/pre-change-enforce.md |
| 治疗循环 | docs/curation-loop.md |
| 运营 | docs/plurbus-operational-guide.md |
| 全文索引 | docs/README.md |
| AI编辑器/代理集成 | docs/integrations/README.md |
| 代理实际上使用内存 | docs/用法/保险代理-usage.md |
______________________________________________________________________
存储库布局
| 目的 | 地点 |
|---|---|
| 控制板API(Go模块) | control-plane/ |
集成包(pluribus-instructions.md、本地模板, skill.md,MCP示例) | integrations/ (+ 文档/集成/) |
| 默认组合堆栈 | |
| 适用法律(本回购) | constitution.md |
| 当前重点 | active.md |
| 工作指令 | workorders/ |
| 证据人工制品 | evidence/ |
工单格式: docs/work-order-form.md.策展风格: docs/记忆库.md.基于文件的检索顺序(适用于工作的代理 *在* 此回购): docs/retrieve-order.md.
______________________________________________________________________
验证和开发
单元测试和兽医 (从 control-plane/):
cd control-plane
make build
go test ./...
go vet ./...回购Makefile目标 (从根开始): make test, make eval, make integration-go (短暂的Postgres+集成测试), make regression--看 构建.md.
______________________________________________________________________
贡献
看 贡献.md.变化应尊重 全局内存, 标签+情境,以及 记忆学说.
