mirror of https://github.com/NousResearch/hermes-agent.git synced 2026-05-20 05:01:30 +00:00

docs: deep audit — fix stale config keys, missing commands, and registry drift (#22784 )

* docs: deep audit — fix stale config keys, missing commands, and registry drift

Cross-checked ~80 high-impact docs pages (getting-started, reference, top-level
user-guide, user-guide/features) against the live registries:

  hermes_cli/commands.py    COMMAND_REGISTRY (slash commands)
  hermes_cli/auth.py        PROVIDER_REGISTRY (providers)
  hermes_cli/config.py      DEFAULT_CONFIG (config keys)
  toolsets.py               TOOLSETS (toolsets)
  tools/registry.py         get_all_tool_names() (tools)
  python -m hermes_cli.main <subcmd> --help (CLI args)

reference/
- cli-commands.md: drop duplicate hermes fallback row + duplicate section,
  add stepfun/lmstudio to --provider enum, expand auth/mcp/curator subcommand
  lists to match --help output (status/logout/spotify, login, archive/prune/
  list-archived).
- slash-commands.md: add missing /sessions and /reload-skills entries +
  correct the cross-platform Notes line.
- tools-reference.md: drop bogus '68 tools' headline, drop fictional
  'browser-cdp toolset' (these tools live in 'browser' and are runtime-gated),
  add missing 'kanban' and 'video' toolset sections, fix MCP example to use
  the real mcp_<server>_<tool> prefix.
- toolsets-reference.md: list browser_cdp/browser_dialog inside the 'browser'
  row, add missing 'kanban' and 'video' toolset rows, drop the stale
  '38 tools' count for hermes-cli.
- profile-commands.md: add missing install/update/info subcommands, document
  fish completion.
- environment-variables.md: dedupe GMI_API_KEY/GMI_BASE_URL rows (kept the
  one with the correct gmi-serving.com default).
- faq.md: Anthropic/Google/OpenAI examples — direct providers exist (not just
  via OpenRouter), refresh the OpenAI model list.

getting-started/
- installation.md: PortableGit (not MinGit) is what the Windows installer
  fetches; document the 32-bit MinGit fallback.
- installation.md / termux.md: installer prefers .[termux-all] then falls
  back to .[termux].
- nix-setup.md: Python 3.12 (not 3.11), Node.js 22 (not 20); fix invalid
  'nix flake update --flake' invocation.
- updating.md: 'hermes backup restore --state pre-update' doesn't exist —
  point at the snapshot/quick-snapshot flow; correct config key
  'updates.pre_update_backup' (was 'update.backup').

user-guide/
- configuration.md: api_max_retries default 3 (not 2); display.runtime_footer
  is the real key (not display.runtime_metadata_footer); checkpoints defaults
  enabled=false / max_snapshots=20 (not true / 50).
- configuring-models.md: 'hermes model list' / 'hermes model set ...' don't
  exist — hermes model is interactive only.
- tui.md: busy_indicator -> tui_status_indicator with values
  kaomoji|emoji|unicode|ascii (not kawaii|minimal|dots|wings|none).
- security.md: SSH backend keys (TERMINAL_SSH_HOST/USER/KEY) live in .env,
  not config.yaml.
- windows-wsl-quickstart.md: there is no 'hermes api' subcommand — the
  OpenAI-compatible API server runs inside hermes gateway.

user-guide/features/
- computer-use.md: approvals.mode (not security.approval_level); fix broken
  ./browser-use.md link to ./browser.md.
- fallback-providers.md: top-level fallback_providers (not
  model.fallback_providers); the picker is subcommand-based, not modal.
- api-server.md: API_SERVER_* are env vars — write to per-profile .env,
  not 'hermes config set' which targets YAML.
- web-search.md: drop web_crawl as a registered tool (it isn't); deep-crawl
  modes are exposed through web_extract.
- kanban.md: failure_limit default is 2, not '~5'.
- plugins.md: drop hard-coded '33 providers' count.
- honcho.md: fix unclosed quote in echo HONCHO_API_KEY snippet; document
  that 'hermes honcho' subcommand is gated on memory.provider=honcho;
  reconcile subcommand list with actual --help output.
- memory-providers.md: legacy 'hermes honcho setup' redirect documented.

Verified via 'npm run build' — site builds cleanly; broken-link count went
from 149 to 146 (no regressions, fixed a few in passing).

* docs: round 2 audit fixes + regenerate skill catalogs

Follow-up to the previous commit on this branch:

Round 2 manual fixes:
- quickstart.md: KIMI_CODING_API_KEY mentioned alongside KIMI_API_KEY;
  voice-mode and ACP install commands rewritten — bare 'pip install ...'
  doesn't work for curl-installed setups (no pip on PATH, not in repo
  dir); replaced with 'cd ~/.hermes/hermes-agent && uv pip install -e
  ".[voice]"'. ACP already ships in [all] so the curl install includes it.
- cli.md / configuration.md: 'auxiliary.compression.model' shown as
  'google/gemini-3-flash-preview' (the doc's own claimed default);
  actual default is empty (= use main model). Reworded as 'leave empty
  (default) or pin a cheap model'.
- built-in-plugins.md: added the bundled 'kanban/dashboard' plugin row
  that was missing from the table.

Regenerated skill catalogs:
- ran website/scripts/generate-skill-docs.py to refresh all 163 per-skill
  pages and both reference catalogs (skills-catalog.md,
  optional-skills-catalog.md). This adds the entries that were genuinely
  missing — productivity/teams-meeting-pipeline (bundled),
  optional/finance/* (entire category — 7 skills:
  3-statement-model, comps-analysis, dcf-model, excel-author, lbo-model,
  merger-model, pptx-author), creative/hyperframes,
  creative/kanban-video-orchestrator, devops/watchers,
  productivity/shop-app, research/searxng-search,
  apple/macos-computer-use — and rewrites every other per-skill page from
  the current SKILL.md. Most diffs are tiny (one line of refreshed
  metadata).

Validation:
- 'npm run build' succeeded.
- Broken-link count moved 146 -> 155 — the +9 are zh-Hans translation
  shells that lag every newly-added skill page (pre-existing pattern).
  No regressions on any en/ page.

2026-05-09 13:19:51 -07:00

4.7 KiB

Raw Blame History

title	sidebar_label	description
Agentmail — Give the agent its own dedicated email inbox via AgentMail	Agentmail	Give the agent its own dedicated email inbox via AgentMail

{/* This page is auto-generated from the skill's SKILL.md by website/scripts/generate-skill-docs.py. Edit the source SKILL.md, not this page. */}

Agentmail

Give the agent its own dedicated email inbox via AgentMail. Send, receive, and manage email autonomously using agent-owned email addresses (e.g. hermes-agent@agentmail.to).

Skill metadata


Source	Optional — install with `hermes skills install official/email/agentmail`
Path	`optional-skills/email/agentmail`
Version	`1.0.0`
Platforms	linux, macos, windows
Tags	`email`, `communication`, `agentmail`, `mcp`

Reference: full SKILL.md

:::info The following is the complete skill definition that Hermes loads when this skill is triggered. This is what the agent sees as instructions when the skill is active. :::

AgentMail — Agent-Owned Email Inboxes

Requirements

AgentMail API key (required) — sign up at https://console.agentmail.to (free tier: 3 inboxes, 3,000 emails/month; paid plans from $20/mo)
Node.js 18+ (for the MCP server)

When to Use

Use this skill when you need to:

Give the agent its own dedicated email address
Send emails autonomously on behalf of the agent
Receive and read incoming emails
Manage email threads and conversations
Sign up for services or authenticate via email
Communicate with other agents or humans via email

This is NOT for reading the user's personal email (use himalaya or Gmail for that). AgentMail gives the agent its own identity and inbox.

Setup

1. Get an API Key

Go to https://console.agentmail.to
Create an account and generate an API key (starts with am_)

2. Configure MCP Server

Add to ~/.hermes/config.yaml (paste your actual key — MCP env vars are not expanded from .env):

mcp_servers:
  agentmail:
    command: "npx"
    args: ["-y", "agentmail-mcp"]
    env:
      AGENTMAIL_API_KEY: "am_your_key_here"

3. Restart Hermes

hermes

All 11 AgentMail tools are now available automatically.

Available Tools (via MCP)

Tool	Description
`list_inboxes`	List all agent inboxes
`get_inbox`	Get details of a specific inbox
`create_inbox`	Create a new inbox (gets a real email address)
`delete_inbox`	Delete an inbox
`list_threads`	List email threads in an inbox
`get_thread`	Get a specific email thread
`send_message`	Send a new email
`reply_to_message`	Reply to an existing email
`forward_message`	Forward an email
`update_message`	Update message labels/status
`get_attachment`	Download an email attachment

Procedure

Create an inbox and send an email

Create a dedicated inbox:
- Use create_inbox with a username (e.g. hermes-agent)
- The agent gets address: hermes-agent@agentmail.to
Send an email:
- Use send_message with inbox_id, to, subject, text
Check for replies:
- Use list_threads to see incoming conversations
- Use get_thread to read a specific thread

Check incoming email

Use list_inboxes to find your inbox ID
Use list_threads with the inbox ID to see conversations
Use get_thread to read a thread and its messages

Reply to an email

Get the thread with get_thread
Use reply_to_message with the message ID and your reply text

Example Workflows

Sign up for a service:

1. create_inbox (username: "signup-bot")
2. Use the inbox address to register on the service
3. list_threads to check for verification email
4. get_thread to read the verification code

Agent-to-human outreach:

1. create_inbox (username: "hermes-outreach")
2. send_message (to: user@example.com, subject: "Hello", text: "...")
3. list_threads to check for replies

Pitfalls

Free tier limited to 3 inboxes and 3,000 emails/month
Emails come from @agentmail.to domain on free tier (custom domains on paid plans)
Node.js (18+) is required for the MCP server (npx -y agentmail-mcp)
The mcp Python package must be installed: pip install mcp
Real-time inbound email (webhooks) requires a public server — use list_threads polling via cronjob instead for personal use

Verification

After setup, test with:

hermes --toolsets mcp -q "Create an AgentMail inbox called test-agent and tell me its email address"

You should see the new inbox address returned.

References

AgentMail docs: https://docs.agentmail.to/
AgentMail console: https://console.agentmail.to
AgentMail MCP repo: https://github.com/agentmail-to/agentmail-mcp
Pricing: https://www.agentmail.to/pricing

4.7 KiB Raw Blame History