[good first issue] docs(hermes): document plugging memory-tencentdb into an existing Hermes#139
Merged
Maxwell-Code07 merged 5 commits intoJun 11, 2026
Conversation
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>
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 |
Collaborator
SuggestionHi @YOMXXX ,Thanks a lot for your contributions! It is recommended to supplement the usage of the Gateway will automatically load the configuration file from the fixed path File Content Format{
"llm": {
"baseUrl": "https://your-api-endpoint/v1",
"apiKey": "your-api-key",
"model": "your-model-name"
}
} |
Updated the README to clarify installation instructions for the Hermes plugin, including Docker usage and configuration steps.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #69 — the original ask:
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.mdandREADME_CN.mdinto two parallel installation paths:npm installthe package (Gateway source ships with it).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.memory.provider: memory_tencentdbin~/.hermes/config.yaml.MEMORY_TENCENTDB_LLM_*env vars.GATEWAY_CMD, or run it yourself.curl /health+ checkagent.logfor the auto-discovery line.At the end of 2.B I link to
hermes-plugin/memory/memory_tencentdb/README.mdso 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
docs/would just make it drift.Test plan
hermes-plugin/memory/memory_tencentdb/README.mdresolves.hermes-agentalready installed; confirmagent.logprintsmemory-tencentdb Gateway command auto-discovered: …and a simple turn captures + recalls.