Skip to main content

Standalone Hermes memory-provider plugin scaffold for Metronix

Project description

hermes-memory-metronix

Standalone Hermes MemoryProvider backed by Metronix Memory.

This repository owns the Hermes-native adapter layer:

  • Hermes plugin packaging
  • config and auth resolution
  • prefetch and write-through behavior
  • Hermes-focused unit, integration, and smoke tests

Metronix backend contracts and MCP integration docs remain in the metronix-memory repository.

Status

This is a scaffold, not a finished public plugin release.

What it already does:

  • Implements the Hermes MemoryProvider contract
  • Prefetches relevant Metronix memory records before a turn
  • Mirrors Hermes memory(action="add") writes into Metronix
  • Optionally writes completed turns as session-scoped Metronix memory
  • Supports bearer-token auth, with email/password login fallback

What is intentionally still conservative:

  • No custom Hermes setup wizard yet
  • No extra provider-specific model tools yet
  • Prefetch currently targets /api/v1/memory/search
  • Knowledge-document / page retrieval is left as a follow-up

Layout

The installable Hermes plugin is this repository root. Its provider implementation lives in:

  • plugin/metronix/

Hermes discovers user-installed memory providers from:

  • ~/.hermes/plugins/<name>/__init__.py

Install

Requires Hermes and Python 3. Choose one option. Both use the same secure, interactive setup command.

Option 1: install script

curl -fsSL https://raw.githubusercontent.com/mtrnix/hermes-memory-metronix/main/scripts/install-plugin.sh | bash

The script installs the latest main branch, then starts hermes-metronix-setup.

Option 2: PyPI

uv tool install "hermes-memory-metronix>=0.1.3"
hermes-metronix-setup --generate-token

--generate-token prompts for your Metronix email and password, then uses curl to create a personal REST API key without printing it. If you already have a REST JWT or personal API key, omit the flag and paste that token instead.

The setup command copies the provider to ~/.hermes/plugins/metronix, writes non-secret settings to ~/.hermes/metronix.json, stores the token in ~/.hermes/.env with 0600 permissions, and runs hermes memory setup metronix.

It never prints the token. Save the original token in a password manager and rotate it if it is exposed. Do not use METRONIX_MCP_API_KEY: it is for MCP, not the REST API used by this provider.

Hermes plugin manager

Alternatively, install this repository directly with Hermes:

hermes plugins install mtrnix/hermes-memory-metronix --no-enable

Quick smoke test

  1. Run hermes memory status; it should show Provider: metronix.

  2. Run hermes chat—there is no --memory-provider chat flag—and enter:

    Remember that my test marker is hermes-metronix-001.
    
  3. Start a fresh hermes chat session and ask for the test marker. A pass includes hermes-metronix-001 in the answer.

hermes memory status may display unused secret fields as “Missing”. The provider accepts either METRONIX_AUTH_TOKEN, or both METRONIX_EMAIL and METRONIX_PASSWORD.

Plugin config

The plugin reads non-secret config from:

  • $HERMES_HOME/metronix.json

And secrets from:

  • $HERMES_HOME/.env
  • process environment

Example metronix.json:

{
  "base_url": "http://localhost:8000",
  "workspace_id": "MTRNIX",
  "agent_id": "hermes",
  "prefetch": true,
  "prefetch_top_k": 8,
  "prefetch_types": ["fact", "preference", "pinned"],
  "cite_sources": true,
  "write_through": true,
  "write_scope": "workspace",
  "sync_turns": true
}

Secrets:

METRONIX_AUTH_TOKEN=...
# or:
METRONIX_EMAIL=admin@metronix.local
METRONIX_PASSWORD=...

Important:

  • METRONIX_AUTH_TOKEN must be a REST JWT or personal API key for /api/v1/*
  • METRONIX_MCP_API_KEY is for /mcp, not /api/v1/memory/*
  • if you provide both a bearer token and login credentials, the client will retry once with a fresh login JWT when the original bearer gets a 401

Mapping notes

Hermes write scopes map to Metronix scopes like this:

  • per_agent -> per_agent
  • workspace -> global
  • shared -> global
  • session -> session

The current prefetch path uses Metronix memory search, so prefetch_types maps to Metronix memory kinds:

  • fact
  • preference
  • pinned

page is not wired yet because the current scaffold does not call a unified knowledge-search endpoint.

Migrating an existing llm-wiki into Metronix

Hermes's bundled llm-wiki skill maintains a directory of markdown pages (entities/, concepts/, comparisons/, queries/, raw/) at $WIKI_PATH (default ~/wiki). To bulk-ingest an existing wiki into Metronix's Knowledge Base (chunked, embedded, searchable via metronix_search_fast/metronix_get):

python scripts/migrate_wiki.py \
  --wiki-path ~/wiki \
  --base-url http://localhost:8000 \
  --workspace-id MTRNIX \
  --auth-token "$METRONIX_AUTH_TOKEN"

Each page becomes a document with source_type="hermes_llm_wiki" and a deterministic doc_label derived from its wiki-relative path, so re-running the script updates existing documents instead of duplicating them. By default, only raw/, entities/, concepts/, comparisons/, and queries/ are ingested; SCHEMA.md, index.md, log*.md, and _archive/** are skipped (pass --include-archive to include archived pages instead).

Requires METRONIX_AUTH_TOKEN to be a REST JWT or personal API key for /api/v1/*, not METRONIX_MCP_API_KEY, which is for /mcp only.

Development

Run the fast local checks:

uv run --extra dev pytest tests/unit -v
RUN_INTEGRATION_TESTS=1 uv run --extra dev pytest tests/integration/test_live_metronix.py -v

Verify against Hermes

Clone a clean Hermes checkout separately, then verify both the current MemoryProvider abstract base class and Hermes's real plugin loader:

HERMES_AGENT_SRC=/absolute/path/to/hermes-agent \
  uv run --extra dev pytest \
  tests/unit/test_real_abc_contract.py tests/unit/test_hermes_plugin.py -v

The compatibility tests skip with an explicit reason when HERMES_AGENT_SRC does not point to a Hermes checkout. They should pass before publishing a plugin release.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hermes_memory_metronix-0.1.4.tar.gz (15.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hermes_memory_metronix-0.1.4-py3-none-any.whl (17.7 kB view details)

Uploaded Python 3

File details

Details for the file hermes_memory_metronix-0.1.4.tar.gz.

File metadata

  • Download URL: hermes_memory_metronix-0.1.4.tar.gz
  • Upload date:
  • Size: 15.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for hermes_memory_metronix-0.1.4.tar.gz
Algorithm Hash digest
SHA256 46bdf7b397c0cbdcfe4ecc09a64171f3abcb387bc41495dd9a6e51debd4de400
MD5 390469f7cfefc4d1f709199e671327b8
BLAKE2b-256 88f7732e2fe5865aba44f2e1577a42140da0930e2297c33cd94a65a9b88135be

See more details on using hashes here.

Provenance

The following attestation bundles were made for hermes_memory_metronix-0.1.4.tar.gz:

Publisher: pypi-publish.yml on mtrnix/hermes-memory-metronix

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file hermes_memory_metronix-0.1.4-py3-none-any.whl.

File metadata

File hashes

Hashes for hermes_memory_metronix-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 d03998bb309989394688f07f087cd2a8cbf5a2d004117104fbdc88463d5404cb
MD5 cad5cd13b972d2b2fb203571fe66b61f
BLAKE2b-256 f99f16ca05d5a2b0bd0c46d8b8534ba54fb9641ca5215bf43ef429aee39dbb66

See more details on using hashes here.

Provenance

The following attestation bundles were made for hermes_memory_metronix-0.1.4-py3-none-any.whl:

Publisher: pypi-publish.yml on mtrnix/hermes-memory-metronix

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page