ReMe/docs/en/integrations.md
Sen Huang 749c653f23
feat(integrations): add automatic memory plugins for Claude Code and Codex (#575)
* feat(integrations): add native Claude Code and Codex memory plugins

* docs(integrations): make plugin installation the coding agent entry point

* feat(integrations): configure plugin connections from user settings

* refactor(codex): use MCP tools and native plugin settings

* fix(codex): restore plugin hooks on current runtimes

* docs(codex): expand setup guide and reserve screenshot slots

* feat(codex): add configurable memory consolidation and status

* feat(codex): merge connection checks into a tabbed status app

* docs(codex): diagnose blocked status panel sandbox loading

* fix(codex): simplify status panel layout for narrow cards

* docs(codex): focus guides on connecting and using ReMe

* docs(codex): specify validated CLI and desktop version requirements

* feat(codex): add ReMe branding to plugin icons

* docs(codex): prepare manual screenshot workflow

* fix(codex): simplify ReMe status layout and activity

* docs(codex): explain Hook loading and local project context

* fix(codex): keep status refresh clear of host close control

* fix(codex): retain status resources for active MCP connections

* docs(codex): add real desktop screenshots to usage guides

* fix(integrations): address memory capture and consolidation review

* fix(codex): preserve capture endpoint during background delivery
2026-10-12 20:12:47 +08:00

103 lines
4.8 KiB
Markdown

---
title: Agent Integrations
description: Connect ReMe to agents through the CLI, HTTP, MCP, Skills, and host adapters.
---
# Agent Integrations
ReMe keeps memory in an independent service and a user-owned workspace. Multiple agents can call the same memory system without binding storage to one model or host.
## Choose an interface
| Scenario | Recommended interface |
|---|---|
| Local script or hook | ReMe CLI |
| Application backend | HTTP Client |
| Tool-protocol host | MCP |
| DeepSeek Harness | [`@agentscope-ai/reme-dsh-plugin`](./integrations/dsh.md) profile bundle |
| OpenClaw | [`@agentscope-ai/reme-openclaw-plugin`](./integrations/openclaw.md) |
| Claude Code | [Start ReMe, then install the plugin](./integrations/claude-code.md) |
| Hermes Agent | Memory provider adapter |
| Codex | [Start ReMe, then install the plugin](./integrations/codex.md) |
| Other coding agents | `reme_memory` Skill or MCP |
## General memory loop
1. Before answering, call `search` for relevant memory.
2. Use `read` on high-value results and `traverse` when relationships matter.
3. Retain workspace-relative source paths in the answer.
4. At session end, pass source messages to `auto_memory`.
5. Let background or scheduled workflows consolidate daily notes into digest memory.
An empty search result must remain empty; do not present model inference as recalled history.
## MCP
The default HTTP service exposes streamable HTTP MCP at `http://127.0.0.1:2333/mcp`. Common tools include `search`,
`read`, `traverse`, `list`, `auto_memory`, and `proactive_read`.
Use `service.jobs` to expose a read-only subset or keep write tools in a separate configuration.
## CLI and Skill
`skills/reme_memory/SKILL.md` defines a general workflow for agents that can run local commands: installation checks, service discovery, retrieval, reading, and persistence boundaries.
It deliberately avoids silently modifying Python environments, stopping unknown processes on port conflicts, writing recalled tool output back as conversation source, or persisting credentials.
## DeepSeek Harness
Install the self-contained [DeepSeek Harness plugin](./integrations/dsh.md):
```bash
dsh plugin --profile web add @agentscope-ai/reme-dsh-plugin
```
Release links: [Awesome DSH Plugin](https://awesome-dsh-plugin.com/p/agentscope-ai/ReMe--integrations-dsh/) and
[npm](https://www.npmjs.com/package/@agentscope-ai/reme-dsh-plugin).
It injects long-term-memory usage guidance into new root-agent sessions and exposes the read-only `reme_search` tool;
it does not preload the full memory history into the prompt. Completed user/assistant turns can be submitted to
`auto_memory` in background batches, while a timezone-aware schedule runs `auto_dream` to consolidate daily notes.
DSH settings configure the endpoint, guidance language, search limits, capture interval, root-agent filtering, and
consolidation schedule. The ReMe Status page exposes Overview, Auto Memory, Memory Consolidation, Components, Journal,
and Personal Knowledge Base views. Runtime counters are diagnostic state; workspace Markdown remains the durable source
of truth.
## OpenClaw
Install the independently published [OpenClaw plugin](./integrations/openclaw.md):
```bash
openclaw plugins install clawhub:@agentscope-ai/reme-openclaw-plugin
```
Release links: [ClawHub](https://clawhub.ai/agentscope-ai/plugins/reme-openclaw-plugin) and
[npm](https://www.npmjs.com/package/@agentscope-ai/reme-openclaw-plugin). The plugin provides its own host-specific
ReMe HTTP boundary and release lifecycle.
## Claude Code
Start the ReMe HTTP service, then install the [ReMe plugin in Claude Code](./integrations/claude-code.md).
The installed plugin supplies automatic recall, completed-turn recording, and memory queries through its
bundled hooks, MCP tools, and skill. This host uses the plugin installation flow.
## Codex
Start the ReMe HTTP service, install the [ReMe plugin in Codex](./integrations/codex.md), and trust its
hooks in `/hooks`. Open a new conversation to use automatic recall, recording, and the plugin's memory tools.
This host also uses the plugin installation flow. Each host keeps its own plugin configuration and retry
queue; the ReMe service owns memory storage and consolidation.
## Hermes Agent
`integrations/hermes_agent/` provides a memory provider with HTTP and embedded modes. It recalls context before model calls and asynchronously invokes `auto_memory` after each turn. Its `config_schema.py` is rendered by Hermes' generic memory settings UI.
## Production guidance
- choose a stable absolute `workspace_dir`;
- reuse a service discovered by `reme find_reme`;
- treat `reme help` as the active Job contract;
- apply timeouts and failure logging to writes;
- do not block the host's core response path when memory is temporarily unavailable;
- use authentication, TLS, and a minimal Job allowlist for remote access.