hermes-agent/website/docs/user-guide/skills/optional/email/email-agentmail.md
treatux 2a1ec15a6f docs(website): regenerate the skill docs from the shipped skill tree
website/scripts/generate-skill-docs.py is the documented source of both catalogs
and of the per-skill pages, but nothing compares its output with what is
committed, so the committed copies drifted:

- optional-skills-catalog.md was missing agent-merge-conflict-arbiter and listed
  pr-lens under blockchain (it lives in software-development);
- skills-catalog.md still listed merge-reconciler, which #98539 moved out of the
  bundled set;
- 196 pages and both catalogs carried Windows path separators — in the Path
  column and inside GitHub blob links, where a backslash is a broken URL.

This commit is the generator's output (re-running it on this branch is a no-op),
plus the orphan page #98539 left behind for merge-reconciler: no skill backs it,
its catalog row is gone, and no page links to it.

tests/skills/test_skill_docs_contract.py is the guard: the next skill that ships
without a catalog row, or a page regenerated on Windows, fails there instead of
on the published page.
2026-09-20 12:54:07 -07:00

4.2 KiB

title sidebar_label description
Agentmail — Use when an agent needs AgentMail CLI email inboxes Agentmail Use when an agent needs AgentMail CLI email inboxes

{/* 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

Use when an agent needs AgentMail CLI email inboxes.

Skill metadata

Source Optional — install with hermes skills install official/email/agentmail
Path optional-skills/email/agentmail
Version 1.0.0
Author Haakam Aujla (Haakam21), AgentMail
License MIT
Platforms linux, macos, windows
Tags Email, CLI, AgentMail, Communication

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 Skill

AgentMail gives an agent its own email inbox for sending mail, receiving replies, completing email OTP flows, and running inbound email loops. Use it for agent-owned inboxes, not a user's existing IMAP/SMTP mailbox.

Use the agentmail CLI first. Use MCP only when the harness expects MCP tools; use REST only when the CLI is missing a required operation.

When to Use

  • The agent needs an email address it owns.
  • The task involves email OTP flows, replies, threads, labels, or attachments.
  • The agent needs webhook or WebSocket delivery for inbound mail.

Prerequisites

  • Run commands through the terminal tool.
  • Install the CLI:
npm install -g agentmail-cli@latest
  • Export an API key:
export AGENTMAIL_API_KEY="am_..."

No API key yet? Use signup.md.

How to Run

Use --format json whenever another command or script needs IDs.

agentmail inboxes list --format json

Quick Reference

Procedure

  1. Install agentmail-cli@latest and verify agentmail inboxes list --format json.
  2. If no API key is available, complete signup.md.
  3. Use core.md for inbox, send, read, reply, forward, label, thread, and attachment flows.
  4. Add webhooks.md or websockets.md only when polling is not enough.

Pitfalls

  • Prefer AGENTMAIL_API_KEY over --api-key.
  • Never expose AGENTMAIL_API_KEY in prompts, logs, URLs, or committed files.
  • Use stable client_id values for retried create operations.
  • Prefer extracted_text or extracted_html for LLM input when present.
  • React to message.received, not messages the agent sent.

Verification

agentmail inboxes list --format json