Skip to content

[good first issue] docs(hermes): document plugging memory-tencentdb into an existing Hermes#139

Merged
Maxwell-Code07 merged 5 commits into
TencentCloud:mainfrom
YOMXXX:feat/69-hermes-integration-docs
Jun 11, 2026
Merged

[good first issue] docs(hermes): document plugging memory-tencentdb into an existing Hermes#139
Maxwell-Code07 merged 5 commits into
TencentCloud:mainfrom
YOMXXX:feat/69-hermes-integration-docs

Conversation

@YOMXXX

@YOMXXX YOMXXX commented Jun 3, 2026

Copy link
Copy Markdown
Contributor

Summary

Fixes #69 — the original ask:

一般情况下都是先装了 hermes 再装插件,不可能是为了使用插件而安装 hermes,目前的文档写的是把 hermes 和插件粗暴的揉在一起的 docker 镜像。

The Hermes-side reference already exists at hermes-plugin/memory/memory_tencentdb/README.md (auto-discovery paths, env-var matrix, supervisor / circuit-breaker behaviour, troubleshooting). The miss was discoverability — the top-level README's Hermes section only pointed at the all-in-one Docker image, so users with an existing Hermes install couldn't find the plug-it-in path.

Change

Restructure section 2 of README.md and README_CN.md into two parallel installation paths:

  • 2.A Docker (greenfield) — the existing one-command flow, unchanged.
  • 2.B Plug into an existing Hermes (no Docker) — new. Six steps:
    1. npm install the package (Gateway source ships with it).
    2. Symlink or copy hermes-plugin/memory/memory_tencentdb/ into <hermes-agent>/plugins/memory/memory_tencentdb/. The "underscore not hyphen" gotcha is called out — Hermes uses the directory name as the provider key.
    3. Set memory.provider: memory_tencentdb in ~/.hermes/config.yaml.
    4. Export the three MEMORY_TENCENTDB_LLM_* env vars.
    5. Pick a Gateway start mode — auto-discovery (default), explicit GATEWAY_CMD, or run it yourself.
    6. curl /health + check agent.log for the auto-discovery line.

At the end of 2.B I link to hermes-plugin/memory/memory_tencentdb/README.md so users tuning the supervisor / circuit breaker get the full reference.

Same content in both English and Chinese READMEs.

What's intentionally NOT in this PR

  • No new docs file. The existing in-repo README is already the right reference; duplicating it in docs/ would just make it drift.
  • No code change. Section 2.B's commands match the behaviour already implemented in the supervisor / SDK client / auto-discovery scan.

Test plan

  • Render both READMEs on GitHub and verify the 2.A / 2.B table renders correctly and the in-repo link to hermes-plugin/memory/memory_tencentdb/README.md resolves.
  • Follow 2.B end-to-end on a clean host with hermes-agent already installed; confirm agent.log prints memory-tencentdb Gateway command auto-discovered: … and a simple turn captures + recalls.
  • Confirm existing Docker users following 2.A see no behaviour change.

The Hermes section in README.md / README_CN.md only documented the
all-in-one Docker image, which is the wrong starting point when the
user already has hermes-agent installed. They don't want to throw
away their setup just to get memory; they want to drop the provider
in next to the other built-in providers.

The full reference already exists at
`hermes-plugin/memory/memory_tencentdb/README.md` (auto-discovery
paths, env vars, supervisor behaviour, troubleshooting). What's
missing is the discoverable entry point at the top-level README.

Restructure section 2 into two parallel paths:

- 2.A Docker — the existing one-command flow, unchanged.
- 2.B Plug into an existing Hermes (no Docker) — new. Covers:
  - installing the npm package so the Gateway source is on disk
  - symlink vs copy of the Python provider into
    `<hermes-agent-checkout>/plugins/memory/memory_tencentdb/`
    (with the "underscore not hyphen" trap called out)
  - the `memory.provider: memory_tencentdb` line in `~/.hermes/config.yaml`
  - the three `MEMORY_TENCENTDB_LLM_*` env vars
  - the three Gateway-start options (auto-discovery / explicit
    GATEWAY_CMD / run-yourself), with auto-discovery as default
  - a `curl /health` verification step
  - a link to the in-repo provider README for the full reference

Docs-only — no code change. Existing Docker users see no difference.

Fixes TencentCloud#69

Signed-off-by: 李冠辰 <liguanchen@xiaomi.com>
@Maxwell-Code07

Copy link
Copy Markdown
Collaborator

Thanks for participating in our Good First Issue program! 🎯

We're keeping these 2 PRs for review:

The PR for #69 — documentation for non-Docker Hermes integration
The PR for #68 — support for ZeroEntropy native embedding API
We'll review them internally and get back to you soon. Really appreciate your contributions and looking forward to merging these! 🚀

@YOMXXX YOMXXX changed the title docs(hermes): document plugging memory-tencentdb into an existing Hermes [good first issue] docs(hermes): document plugging memory-tencentdb into an existing Hermes Jun 4, 2026
@Maxwell-Code07 Maxwell-Code07 added the good first issue Good for newcomers label Jun 4, 2026
@Maxwell-Code07

Copy link
Copy Markdown
Collaborator

Suggestion

Hi @YOMXXX ,Thanks a lot for your contributions! It is recommended to supplement the usage of the tdai-gateway.json configuration file as an alternative to environment variables.

Gateway will automatically load the configuration file from the fixed path ~/.memory-tencentdb/memory-tdai/tdai-gateway.json without additional settings, which is more suitable for long-term use.

File Content Format

{
  "llm": {
    "baseUrl": "https://your-api-endpoint/v1",
    "apiKey": "your-api-key",
    "model": "your-model-name"
  }
}

YOMXXX and others added 4 commits June 9, 2026 09:22
Updated the README to clarify installation instructions for the Hermes plugin, including Docker usage and configuration steps.
@Maxwell-Code07 Maxwell-Code07 merged commit 46e9977 into TencentCloud:main Jun 11, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

good first issue Good for newcomers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[good first issue]🎯 [Feature] 希望有一篇如何集成到hermes agent的文档

2 participants