Skip to content

Commit 1549987

Browse files
benfrank241claude
benfrank241
and
claude
authored
docs: Add Omnigent integration page (#2710)
* docs: add Omnigent integration page Adds the Omnigent integration to the docs site: - docs-integrations/omnigent.md — full integration guide (install, YAML config, how runner-local dispatch works, bank scoping, config reference, self-hosted, Remy example, harness table, further reading) - src/data/integrations.json — registry entry (category: framework, official) - static/img/icons/omnigent.png — placeholder icon (to be updated) Tool names use the correct Omnigent source names: memory_recall/retain/reflect. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * docs: fix broken links, real Omnigent logo, regen skill - Remove changelog link (Omnigent has no released Hindsight package/changelog) - Drop the not-yet-merged blog self-link; add Omnigent GitHub link instead - Replace placeholder icon with the real Omnigent logo (from omnigent-ai/omnigent) - Regenerate skills/hindsight-docs integration reference for omnigent Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * docs(omnigent): correct tool names to hindsight_* + fix harness table - Revert memory_* -> hindsight_recall/retain/reflect: released omnigent v0.5.1 (and main, and the Remy example) use hindsight_* names. The memory_* rename is on an unmerged branch (integration/hindsight-memory-tool), not released. - Fix the harness table: Codex and OpenCode have official Hindsight integrations, Pi has a community one (epimetheus); reframe around 'one central setup' rather than implying those tools have no native support. - Regenerate skills/hindsight-docs reference. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent b0e5d10 commit 1549987

4 files changed

Lines changed: 257 additions & 0 deletions

File tree

‎hindsight-docs/docs-integrations/omnigent.md‎

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
---
2+
sidebar_position: 41
3+
title: "Omnigent Persistent Memory with Hindsight | Integration"
4+
description: "Give every harness you run in Omnigent persistent memory. One Hindsight setup powers hindsight_recall, hindsight_retain, and hindsight_reflect across Claude Code, Codex, Cursor, Hermes, Pi, and any custom agent."
5+
---
6+
7+
# Omnigent
8+
9+
Persistent long-term memory for every harness in [Omnigent](https://github.com/omnigent-ai/omnigent) — the meta-harness that wraps and coordinates multiple AI agents (Claude Code, Codex, Cursor, OpenCode, Hermes, Pi, and more).
10+
11+
Omnigent ships three built-in memory tools — `hindsight_recall`, `hindsight_retain`, and `hindsight_reflect` — that Omnigent intercepts and executes locally using `hindsight-client`. Because the tools live in the Omnigent runner rather than in each harness, every wrapped agent gets memory regardless of whether it has native Hindsight support.
12+
13+
## Installation
14+
15+
```bash
16+
pip install "omnigent[memory]"
17+
export HINDSIGHT_API_KEY=hsk_...
18+
```
19+
20+
Get an API key from [Hindsight Cloud](https://ui.hindsight.vectorize.io/signup), or point at a self-hosted server with `HINDSIGHT_API_URL`.
21+
22+
## Setup
23+
24+
Add the three tools to your agent's YAML spec under `tools.builtins`:
25+
26+
```yaml
27+
name: my-agent
28+
29+
tools:
30+
builtins:
31+
- name: hindsight_recall
32+
api_key: ${HINDSIGHT_API_KEY}
33+
bank_id: my-agent-memory # optional; defaults to agent_id
34+
budget: mid # low / mid / high
35+
max_tokens: 4096
36+
37+
- name: hindsight_retain
38+
api_key: ${HINDSIGHT_API_KEY}
39+
bank_id: my-agent-memory
40+
41+
- name: hindsight_reflect
42+
api_key: ${HINDSIGHT_API_KEY}
43+
bank_id: my-agent-memory
44+
```
45+
46+
Restart your agent — the three tools will appear in its tool list.
47+
48+
## How It Works
49+
50+
Omnigent intercepts `hindsight_*` calls at the runner level before they reach the wrapped harness, executes them locally via `hindsight-client`, and returns the result. This means:
51+
52+
- **Wrapped harnesses** (Claude Code, Codex, Cursor, Pi…) never need to handle the call; the runner does it.
53+
- **Native harnesses** (when running agents in native mode) have the tools relayed to them as well.
54+
- **One setup for all of them.** Many of these harnesses have their own native Hindsight integration, but through Omnigent you configure memory once and it applies to every harness you orchestrate, including custom ones with no native option.
55+
56+
The agent calls the tools **explicitly**; there are no automatic lifecycle hooks. Include instructions in your agent's system prompt:
57+
58+
```
59+
- At the start of each task, call hindsight_recall with the user's request
60+
to load relevant decisions, preferences, and project context.
61+
- When the user gives you a durable fact (a convention, a decision, a
62+
preference), call hindsight_retain to store it.
63+
- Call hindsight_reflect to synthesize what you know about a topic across sessions.
64+
```
65+
66+
## Bank Scoping
67+
68+
Omnigent resolves the memory bank in this order:
69+
70+
1. The explicit `bank_id` in your YAML config — most predictable, recommended.
71+
2. The agent's `agent_id` — one bank per agent, shared across conversations.
72+
3. The `conversation_id` — one bank per conversation; lost when the conversation ends.
73+
74+
To share memory between two agents, point them at the same `bank_id`.
75+
76+
## Configuration Reference
77+
78+
| Field | Description | Default |
79+
|---|---|---|
80+
| `api_key` | Hindsight API key | _(required for Cloud)_ |
81+
| `api_url` | Hindsight API base URL | `https://api.hindsight.vectorize.io` |
82+
| `bank_id` | Memory bank name | `agent_id` or `conversation_id` |
83+
| `budget` | Recall token budget (`low` / `mid` / `high`) | `mid` |
84+
| `max_tokens` | Maximum tokens returned by recall | `4096` |
85+
| `tags` | CSV tags applied to retained memories | _(none)_ |
86+
| `recall_tags` | CSV tags to filter recalled memories | _(none)_ |
87+
| `recall_tags_match` | Tag match mode (`any` / `all` / `any_strict` / `all_strict`) | `any` |
88+
89+
## Self-Hosted
90+
91+
Point at your own server with `api_url`; no token needed for an open server:
92+
93+
```yaml
94+
- name: hindsight_recall
95+
api_url: http://localhost:8888
96+
bank_id: local-memory
97+
```
98+
99+
## Working Example
100+
101+
Omnigent ships a complete example at [`examples/remy/config.yaml`](https://github.com/omnigent-ai/omnigent/blob/main/examples/remy/config.yaml) — a conversational assistant with all three tools wired up and instructions on when to call each one:
102+
103+
```bash
104+
HINDSIGHT_API_KEY=hsk_... omnigent run examples/remy
105+
```
106+
107+
After a few conversations, ask it something it learned in a previous session.
108+
109+
## Which Harnesses Benefit
110+
111+
| Harness | Native Hindsight integration | Via Omnigent |
112+
|---|---|---|
113+
| Claude Code | Yes (official) | Yes |
114+
| Cursor | Yes (official) | Yes |
115+
| Codex | Yes (official) | Yes |
116+
| OpenCode | Yes (official) | Yes |
117+
| Pi | Yes (community, via epimetheus) | Yes |
118+
| Custom harness | Usually none | Yes |
119+
120+
Most of these harnesses already have a native Hindsight integration, ideal when you run that tool standalone. Omnigent's value is one central memory setup that spans every harness you orchestrate at once, plus coverage for custom harnesses with no native option.
121+
122+
## Further Reading
123+
124+
- [One memory for every AI tool](/blog/2026/04/07/one-memory-for-every-ai-tool): point multiple harnesses at the same bank.
125+
- [Inside retain()](/blog/2026/07/13/inside-retain-agent-memory): what happens when the agent calls `hindsight_retain`.
126+
- [Omnigent on GitHub](https://github.com/omnigent-ai/omnigent): the meta-harness source and examples.

‎hindsight-docs/src/data/integrations.json‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -580,6 +580,16 @@
580580
"link": "/sdks/integrations/devin-desktop",
581581
"icon": "/img/icons/devin-desktop.svg"
582582
},
583+
{
584+
"id": "omnigent",
585+
"name": "Omnigent",
586+
"description": "Give every harness you run in Omnigent persistent memory. One setup wires memory_recall, memory_retain, and memory_reflect across Claude Code, Codex, Cursor, Hermes, Pi, and any custom agent.",
587+
"type": "official",
588+
"by": "hindsight",
589+
"category": "framework",
590+
"link": "/sdks/integrations/omnigent",
591+
"icon": "/img/icons/omnigent.png"
592+
},
583593
{
584594
"id": "epimetheus",
585595
"name": "Epimetheus",

‎hindsight-docs/static/img/icons/omnigent.png‎

17 KB
Loading

‎skills/hindsight-docs/references/sdks/integrations/omnigent.md‎

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
2+
# Omnigent
3+
4+
Persistent long-term memory for every harness in [Omnigent](https://github.com/omnigent-ai/omnigent) — the meta-harness that wraps and coordinates multiple AI agents (Claude Code, Codex, Cursor, OpenCode, Hermes, Pi, and more).
5+
6+
Omnigent ships three built-in memory tools — `hindsight_recall`, `hindsight_retain`, and `hindsight_reflect` — that Omnigent intercepts and executes locally using `hindsight-client`. Because the tools live in the Omnigent runner rather than in each harness, every wrapped agent gets memory regardless of whether it has native Hindsight support.
7+
8+
## Installation
9+
10+
```bash
11+
pip install "omnigent[memory]"
12+
export HINDSIGHT_API_KEY=hsk_...
13+
```
14+
15+
Get an API key from [Hindsight Cloud](https://ui.hindsight.vectorize.io/signup), or point at a self-hosted server with `HINDSIGHT_API_URL`.
16+
17+
## Setup
18+
19+
Add the three tools to your agent's YAML spec under `tools.builtins`:
20+
21+
```yaml
22+
name: my-agent
23+
24+
tools:
25+
builtins:
26+
- name: hindsight_recall
27+
api_key: ${HINDSIGHT_API_KEY}
28+
bank_id: my-agent-memory # optional; defaults to agent_id
29+
budget: mid # low / mid / high
30+
max_tokens: 4096
31+
32+
- name: hindsight_retain
33+
api_key: ${HINDSIGHT_API_KEY}
34+
bank_id: my-agent-memory
35+
36+
- name: hindsight_reflect
37+
api_key: ${HINDSIGHT_API_KEY}
38+
bank_id: my-agent-memory
39+
```
40+
41+
Restart your agent — the three tools will appear in its tool list.
42+
43+
## How It Works
44+
45+
Omnigent intercepts `hindsight_*` calls at the runner level before they reach the wrapped harness, executes them locally via `hindsight-client`, and returns the result. This means:
46+
47+
- **Wrapped harnesses** (Claude Code, Codex, Cursor, Pi…) never need to handle the call; the runner does it.
48+
- **Native harnesses** (when running agents in native mode) have the tools relayed to them as well.
49+
- **One setup for all of them.** Many of these harnesses have their own native Hindsight integration, but through Omnigent you configure memory once and it applies to every harness you orchestrate, including custom ones with no native option.
50+
51+
The agent calls the tools **explicitly**; there are no automatic lifecycle hooks. Include instructions in your agent's system prompt:
52+
53+
```
54+
- At the start of each task, call hindsight_recall with the user's request
55+
to load relevant decisions, preferences, and project context.
56+
- When the user gives you a durable fact (a convention, a decision, a
57+
preference), call hindsight_retain to store it.
58+
- Call hindsight_reflect to synthesize what you know about a topic across sessions.
59+
```
60+
61+
## Bank Scoping
62+
63+
Omnigent resolves the memory bank in this order:
64+
65+
1. The explicit `bank_id` in your YAML config — most predictable, recommended.
66+
2. The agent's `agent_id` — one bank per agent, shared across conversations.
67+
3. The `conversation_id` — one bank per conversation; lost when the conversation ends.
68+
69+
To share memory between two agents, point them at the same `bank_id`.
70+
71+
## Configuration Reference
72+
73+
| Field | Description | Default |
74+
|---|---|---|
75+
| `api_key` | Hindsight API key | _(required for Cloud)_ |
76+
| `api_url` | Hindsight API base URL | `https://api.hindsight.vectorize.io` |
77+
| `bank_id` | Memory bank name | `agent_id` or `conversation_id` |
78+
| `budget` | Recall token budget (`low` / `mid` / `high`) | `mid` |
79+
| `max_tokens` | Maximum tokens returned by recall | `4096` |
80+
| `tags` | CSV tags applied to retained memories | _(none)_ |
81+
| `recall_tags` | CSV tags to filter recalled memories | _(none)_ |
82+
| `recall_tags_match` | Tag match mode (`any` / `all` / `any_strict` / `all_strict`) | `any` |
83+
84+
## Self-Hosted
85+
86+
Point at your own server with `api_url`; no token needed for an open server:
87+
88+
```yaml
89+
- name: hindsight_recall
90+
api_url: http://localhost:8888
91+
bank_id: local-memory
92+
```
93+
94+
## Working Example
95+
96+
Omnigent ships a complete example at [`examples/remy/config.yaml`](https://github.com/omnigent-ai/omnigent/blob/main/examples/remy/config.yaml) — a conversational assistant with all three tools wired up and instructions on when to call each one:
97+
98+
```bash
99+
HINDSIGHT_API_KEY=hsk_... omnigent run examples/remy
100+
```
101+
102+
After a few conversations, ask it something it learned in a previous session.
103+
104+
## Which Harnesses Benefit
105+
106+
| Harness | Native Hindsight integration | Via Omnigent |
107+
|---|---|---|
108+
| Claude Code | Yes (official) | Yes |
109+
| Cursor | Yes (official) | Yes |
110+
| Codex | Yes (official) | Yes |
111+
| OpenCode | Yes (official) | Yes |
112+
| Pi | Yes (community, via epimetheus) | Yes |
113+
| Custom harness | Usually none | Yes |
114+
115+
Most of these harnesses already have a native Hindsight integration, ideal when you run that tool standalone. Omnigent's value is one central memory setup that spans every harness you orchestrate at once, plus coverage for custom harnesses with no native option.
116+
117+
## Further Reading
118+
119+
- One memory for every AI tool: point multiple harnesses at the same bank.
120+
- Inside retain(): what happens when the agent calls `hindsight_retain`.
121+
- [Omnigent on GitHub](https://github.com/omnigent-ai/omnigent): the meta-harness source and examples.

0 commit comments

Comments
 (0)