agent-cards / README.md
Elron's picture
Duplicate from open-agent-leaderboard/agent-cards
1a17759

Agent Cards

A standardized format for documenting AI agent systems -- what they are, how they work, and how they perform.

Model cards describe models. Agent cards describe agents: the full system including planning strategy, tool use, memory, error recovery, and the models inside them.

Why agent cards?

Evaluating an agent isn't just about what score it gets. It's about understanding the system that produced that score. Two agents can achieve identical benchmark results while differing dramatically in cost, failure modes, and architecture. Agent cards make these differences visible.

See Rethinking Agent Evaluation Reporting for the motivation behind this format.

Quick start

Copy the template and fill it in for your agent. See examples/ for reference.

Template structure

An agent card is a markdown file with YAML frontmatter:

Frontmatter (machine-readable):

  • Identity: name, version, developers, license
  • Framework and repository
  • Models used
  • Tags for discoverability

Sections (human-readable):

  1. Agent Details -- what it is
  2. Architecture -- how it works (planning, memory, tools, error recovery)
  3. Models -- which LLMs and how they're used
  4. Supported Environments -- what domains and benchmarks it handles
  5. Evaluation Results -- performance, cost, and failure data
  6. Limitations -- known failure modes and unsupported scenarios
  7. How to Run -- installation and usage