Skip to content

docs(readme): show how to extend agentmemory with iii workers#242

Merged
rohitg00 merged 3 commits intomainfrom
docs/extend-with-iii-workers
May 8, 2026
Merged

docs(readme): show how to extend agentmemory with iii workers#242
rohitg00 merged 3 commits intomainfrom
docs/extend-with-iii-workers

Conversation

@rohitg00
Copy link
Copy Markdown
Owner

@rohitg00 rohitg00 commented May 8, 2026

Summary

  • Promote the iii console to its own README section so users can find it without scrolling through the viewer block.
  • Add an Extend with one command section that maps each iii worker add <name> to a concrete agentmemory capability: multi-instance memory, scheduled consolidation, durable retries, sandboxed code exec, SQL state, extra MCP host.
  • Drop the buried "Architecture" footer and roll the stack-replacement table into the new section.

What's new on the README

iii worker add Capability on top of agentmemory
iii-pubsub Multi-instance memory — fan out writes, union reads
iii-cron Scheduled consolidation, decay sweeps, snapshot rotation
iii-queue Durable retries for embedding + compression jobs
iii-observability OTEL traces on every memory op (default on)
iii-sandbox Run recalled code inside a microVM, not the shell
iii-database SQL-backed state adapter
mcp Extra MCP host alongside agentmemory's

Every entry links to its page on workers.iii.dev, so users can install and see new functions appear in the viewer + console without any further config.

Test plan

  • Render README on github.com/rohitg00/agentmemory and confirm anchors (#iii-console, #powered-by-iii) resolve.
  • Confirm every iii worker add worker name resolves at https://workers.iii.dev/workers/<name>.
  • Sanity-check headings on mobile width.

Summary by CodeRabbit

  • Documentation
    • Reorganized navigation to surface "iii Console" and "Powered by iii"
    • Rewrote iii Console content to contrast viewer vs. console with concrete examples (tracing, KV edits, hook replay, stream pinning)
    • Added "Powered by iii" overview and worker capability guidance
    • Removed prior architecture section for clearer focus

Promote the iii console to its own section and add an "Extend with one
command" section that maps each `iii worker add <name>` to a concrete
agentmemory capability — multi-instance memory, scheduled consolidation,
durable retries on embeddings, sandboxed code execution, SQL state
adapter, and an extra MCP host.

Lists only workers published on workers.iii.dev with direct links to
each registry page so users can install them and see the new functions
appear in the viewer + console immediately.
@vercel
Copy link
Copy Markdown

vercel Bot commented May 8, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
agentmemory Ready Ready Preview, Comment May 8, 2026 4:43pm

Request Review

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 8, 2026

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 301eba07-5e4a-4482-be5a-2ec569b1cff6

📥 Commits

Reviewing files that changed from the base of the PR and between 6be98d2 and 6930c4f.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

README navigation and content are reorganized: hero and TOC links updated, the iii-console section rewritten to contrast viewer vs console with examples, a new "Powered by iii" section documents worker-based extensibility, and the prior architecture section is removed.

Changes

Documentation Restructure

Layer / File(s) Summary
Navigation Header & Hero Update
README.md
Hero tagline linked to "Built on iii engine"; TOC splits "iii Console — trace-level engine inspection" into separate "iii Console" and "Powered by iii" links.
iii Console Section Rewrite
README.md
iii-console content rewritten to contrast viewer (what the agent remembered) vs console (what the agent did), with examples: tracing waterfalls, stream pinning, KV editing, and hook replay.
Powered by iii Section Addition
README.md
New section describing agentmemory as an already-running iii instance, documents iii worker add extension options, includes worker→capability mapping and a "What iii replaces" comparison table.
Architecture Section Removal
README.md
Removed the prior "architecture" section that explained iii-engine primitives and listed what iii-engine replaces.

Sequence Diagram(s)

sequenceDiagram
  participant User
  participant Viewer
  participant iiiConsole
  User->>Viewer: inspect remembered state
  User->>iiiConsole: trace agent actions / replay hooks
  iiiConsole->>User: show streams, allow edits/pinning
Loading

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly Related PRs

Poem

🐰 I hop through docs anew,
Links split and sections bloom,
The console shows what the agent did,
Workers hum and add their tune,
Docs shine bright beneath the moon.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title 'docs(readme): show how to extend agentmemory with iii workers' accurately summarizes the main change: adding documentation on extending agentmemory with iii workers. It directly matches the primary objective of promoting the iii console section and documenting worker extensibility.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/extend-with-iii-workers
⚔️ Resolve merge conflicts
  • Resolve merge conflict in branch docs/extend-with-iii-workers

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@rohitg00 rohitg00 merged commit b91a9a7 into main May 8, 2026
3 of 4 checks passed
@rohitg00 rohitg00 deleted the docs/extend-with-iii-workers branch May 8, 2026 16:43
rohitg00 added a commit that referenced this pull request May 9, 2026
Bug-fix patch focused on search recall correctness and plugin
compatibility. Pins iii-engine to v0.11.2 because v0.11.6 introduces
a new sandbox-everything-via-`iii worker add` model that agentmemory
hasn't been refactored for yet — pin lifts once that refactor lands.
Adds a hard guard against silent vector-index corruption, fixes BM25
indexing for memories saved via memory_save, and lands four Hermes
plugin fixes.

Per AGENTS.md release checklist:
- package.json version 0.9.4 -> 0.9.5
- src/version.ts VERSION constant
- src/types.ts ExportData version union
- src/functions/export-import.ts supportedVersions Set
- test/export-import.test.ts assertion
- plugin/.claude-plugin/plugin.json version
- CHANGELOG.md detailed entries with contributor shoutouts

Headlines (full detail in CHANGELOG):

Fixed:
- BM25 search now indexes memories saved via memory_save (#258, #257)
  Thanks @Nizar-BenHamida for the precise repro.
- Embedding providers no longer silently corrupt the vector index when
  an API returns wrong-dimension vectors (#248, #247, #256)
  Thanks @AmmarSaleh50 for issue + fix + tests.
- Hermes handle_tool_call returns JSON strings, not raw dicts (#255, #254)
  Thanks @KyoMio for the Anthropic-protocol repro.
- Hermes status reflects real service state on systemd installs (#253, #250)
  Thanks @OptionalCoin for tracing it to env-source divergence.
- Hermes hooks accept passthrough kwargs (#252, #249)
  Thanks @OptionalCoin again for the log analysis.
- agentmemory demo now seeds observations correctly (#251, #229)
  Thanks @seishonagon for root-cause analysis.
- LLM compression / summarization timeouts increased (#213)
  Thanks @xuli500177.
- Pi / OpenClaw / Hermes integration plugin fixes (#230)
  Thanks @deepmroot.

Changed:
- iii-engine pinned to v0.11.2 across every install path (#260).
  v0.11.6 introduces a new `iii worker add` sandbox model that
  agentmemory still pre-dates; pin lifts when we refactor agentmemory
  to register as a sandboxed worker. Override with
  AGENTMEMORY_III_VERSION=<version> for users who've migrated manually.
- README documents iii worker add extension surface (#242).
- README iii Console install/launch commands corrected (#243).

Validated: 852/852 tests pass, npm run build clean.
rohitg00 added a commit that referenced this pull request May 9, 2026
Bug-fix patch focused on search recall correctness and plugin
compatibility. Pins iii-engine to v0.11.2 because v0.11.6 introduces
a new sandbox-everything-via-`iii worker add` model that agentmemory
hasn't been refactored for yet — pin lifts once that refactor lands.
Adds a hard guard against silent vector-index corruption, fixes BM25
indexing for memories saved via memory_save, and lands four Hermes
plugin fixes.

Per AGENTS.md release checklist:
- package.json version 0.9.4 -> 0.9.5
- src/version.ts VERSION constant
- src/types.ts ExportData version union
- src/functions/export-import.ts supportedVersions Set
- test/export-import.test.ts assertion
- plugin/.claude-plugin/plugin.json version
- CHANGELOG.md detailed entries with contributor shoutouts

Headlines (full detail in CHANGELOG):

Fixed:
- BM25 search now indexes memories saved via memory_save (#258, #257)
  Thanks @Nizar-BenHamida for the precise repro.
- Embedding providers no longer silently corrupt the vector index when
  an API returns wrong-dimension vectors (#248, #247, #256)
  Thanks @AmmarSaleh50 for issue + fix + tests.
- Hermes handle_tool_call returns JSON strings, not raw dicts (#255, #254)
  Thanks @KyoMio for the Anthropic-protocol repro.
- Hermes status reflects real service state on systemd installs (#253, #250)
  Thanks @OptionalCoin for tracing it to env-source divergence.
- Hermes hooks accept passthrough kwargs (#252, #249)
  Thanks @OptionalCoin again for the log analysis.
- agentmemory demo now seeds observations correctly (#251, #229)
  Thanks @seishonagon for root-cause analysis.
- LLM compression / summarization timeouts increased (#213)
  Thanks @xuli500177.
- Pi / OpenClaw / Hermes integration plugin fixes (#230)
  Thanks @deepmroot.

Changed:
- iii-engine pinned to v0.11.2 across every install path (#260).
  v0.11.6 introduces a new `iii worker add` sandbox model that
  agentmemory still pre-dates; pin lifts when we refactor agentmemory
  to register as a sandboxed worker. Override with
  AGENTMEMORY_III_VERSION=<version> for users who've migrated manually.
- README documents iii worker add extension surface (#242).
- README iii Console install/launch commands corrected (#243).

Validated: 852/852 tests pass, npm run build clean.
rohitg00 added a commit that referenced this pull request May 9, 2026
Bug-fix patch focused on search recall correctness and plugin
compatibility. Pins iii-engine to v0.11.2 because v0.11.6 introduces
a new sandbox-everything-via-`iii worker add` model that agentmemory
hasn't been refactored for yet — pin lifts once that refactor lands.
Adds a hard guard against silent vector-index corruption, fixes BM25
indexing for memories saved via memory_save, and lands four Hermes
plugin fixes.

Per AGENTS.md release checklist:
- package.json version 0.9.4 -> 0.9.5
- src/version.ts VERSION constant
- src/types.ts ExportData version union
- src/functions/export-import.ts supportedVersions Set
- test/export-import.test.ts assertion
- plugin/.claude-plugin/plugin.json version
- CHANGELOG.md detailed entries with contributor shoutouts

Headlines (full detail in CHANGELOG):

Fixed:
- BM25 search now indexes memories saved via memory_save (#258, #257)
  Thanks @Nizar-BenHamida for the precise repro.
- Embedding providers no longer silently corrupt the vector index when
  an API returns wrong-dimension vectors (#248, #247, #256)
  Thanks @AmmarSaleh50 for issue + fix + tests.
- Hermes handle_tool_call returns JSON strings, not raw dicts (#255, #254)
  Thanks @KyoMio for the Anthropic-protocol repro.
- Hermes status reflects real service state on systemd installs (#253, #250)
  Thanks @OptionalCoin for tracing it to env-source divergence.
- Hermes hooks accept passthrough kwargs (#252, #249)
  Thanks @OptionalCoin again for the log analysis.
- agentmemory demo now seeds observations correctly (#251, #229)
  Thanks @seishonagon for root-cause analysis.
- LLM compression / summarization timeouts increased (#213)
  Thanks @xuli500177.
- Pi / OpenClaw / Hermes integration plugin fixes (#230)
  Thanks @deepmroot.

Changed:
- iii-engine pinned to v0.11.2 across every install path (#260).
  v0.11.6 introduces a new `iii worker add` sandbox model that
  agentmemory still pre-dates; pin lifts when we refactor agentmemory
  to register as a sandboxed worker. Override with
  AGENTMEMORY_III_VERSION=<version> for users who've migrated manually.
- README documents iii worker add extension surface (#242).
- README iii Console install/launch commands corrected (#243).

Validated: 852/852 tests pass, npm run build clean.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant