agentsmd

Scaffold, validate, and sync AI agent context for your app. Author context in CodingAgent.md (or AGENTS.md), then sync so Cursor and other tools load it automatically.

Quick start

npm install
npm run build
npm link   # optional: use `agentsmd` globally

cd your-app
agentsmd init
# Edit CodingAgent.md with your product, stack, commands, conventions
agentsmd sync
agentsmd doctor

Commands

| Command | Description | |---------|-------------| | agentsmd init | Create CodingAgent.md from template | | agentsmd sync | Write AGENTS.md and .cursor/rules/app-context.mdc | | agentsmd sync --no-cursor | Skip Cursor rule; only update AGENTS.md | | agentsmd validate | Check sections, size, @file references | | agentsmd doctor | Setup checklist (files present, in sync) | | agentsmd show | List discovered context files | | agentsmd print | Output merged markdown (for scripts / MCP) |

How context is discovered

From your current directory up to the git root (or cwd), agentsmd collects:

• CodingAgent.md (preferred authoring name)
• AGENTS.md (standard name read by Cursor)

Nested folders merge root → leaf; deeper files add more specific guidance.

Programmatic API

import { loadContext, syncContext, validateContext } from "agentsmd";

const ctx = loadContext("/path/to/project");
if (ctx) {
  console.log(ctx.markdown); // inject into your agent / MCP
}

Recommended workflow

1. agentsmd init — one CodingAgent.md at repo root
2. Fill in Product, Stack, Commands, Architecture, Conventions, Guardrails, Workflow
3. agentsmd sync — keeps AGENTS.md + Cursor rule in sync
4. agentsmd validate in CI (use --strict to fail on warnings)
5. Add nested CodingAgent.md in monorepo packages when rules differ

License

MIT