agents.mdx

Write AGENTS.mdx with live data components, compile to AGENTS.md, CLAUDE.md, and .cursorrules.

Install

npm install agents.mdx

Usage

npx agents.mdx

That's it. This will:

1. Create AGENTS.mdx if it doesn't exist
2. Compile to AGENTS.md, CLAUDE.md, and .cursorrules

AGENTS.mdx

---
name: My Project
---

# Context

You are working on {name}.

## Current Work

<Issues.Ready limit={10} />

## Recent Changes

<GitLog limit={5} />

Output Formats

By default, outputs all formats:

• AGENTS.md - Universal standard (GitHub Copilot, Jules, Codex, etc.)
• CLAUDE.md - Claude Code
• .cursorrules - Cursor

To output only specific formats, add to frontmatter:

---
format: claude
---

Or comma-separated:

---
format: agents, claude
---

Components

Issues

<Issues />                    <!-- All issues -->
<Issues.Ready limit={10} />   <!-- Ready to work -->
<Issues.Blocked />            <!-- Blocked issues -->
<Issue id="proj-123" />       <!-- Single issue -->

Epics

<Epics />                     <!-- All epics with progress -->
<Epic id="v1.0" />            <!-- Single epic -->

Git

<GitLog limit={5} />          <!-- Recent commits -->
<GitStatus />                 <!-- Working tree status -->

Custom Components

import { registerComponent } from 'agents.mdx'

registerComponent('JiraTickets', async (props) => {
  const tickets = await fetchJira(props.project)
  return tickets.map(t => `- [${t.key}] ${t.summary}`).join('\n')
})

Claude Code Plugin

Auto-hydrate on session start:

claude /plugin install agents.mdx

Documentation

agents.mdx.do

License

MIT