agentleFS
aws-solutionsaws-solutions/konductor/skills/agents-md-authoring/SKILL.md

agents-md-authoring

Skill11 starsChanged 49 days agoApache-2.0View on GitHub

Create and maintain AGENTS.md files that bootstrap AI agent context. Use when a project lacks an AGENTS.md, when onboarding a repo for AI agents, or when updating project conventions agents should follow. Covers the agents.md standard, the context-loading instruction block, and the CLAUDE.md bridge for Claude Code.

The file

We split this skill into the rules it gives an agent

4 rules. About 0 are common, 2 are distinctive, and 2 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈2

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Keep it concise and scannable — bullets and short sections, not prose.

    line 70
  2. Very specific:

    When asked to edit CLAUDE.md, edit AGENTS.md instead (CLAUDE.md should just @AGENTS.md).

    line 72
  3. Distinctive:

    Check whether AGENTS.md exists at the repo root.

    line 76
  4. Very specific:

    Ensure a CLAUDE.md exists with @AGENTS.md (create it if missing) for Claude Code compatibility.

    line 78

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

AGENTS.md Authoring

AGENTS.md is a README for AI agents — a predictable place at the repo root for project context and instructions. It is part of the open agents.md standard, read by many agentic tools.

When to create or update

  • A repository has no AGENTS.md and agents are working in it
  • Project conventions, build commands, or structure changed
  • A durable learning should be promoted from session memory into permanent project guidance

Critical: how AGENTS.md is loaded (differs by runtime)

Kiro CLI custom agentsClaude Code custom agents
AGENTS.mdNOT auto-read — must be in the agent's clientConfig.kiroCli.resources as file://AGENTS.mdNOT auto-read — Claude Code only reads CLAUDE.md
CLAUDE.mdNOT auto-readAuto-read at session start (all hierarchy levels)

Implication: AGENTS.md does NOT support import directives (@path or #[[file:]]) when loaded by Kiro. To make agents load steering/memory/skills, use instructions inside AGENTS.md (see below), not imports.

Bootstrap requirements

  1. Kiro: the agent spec must list "file://AGENTS.md" in clientConfig.kiroCli.resources.
  2. Claude Code: the repo must have a CLAUDE.md containing @AGENTS.md (import) so Claude Code loads AGENTS.md content. Chain further imports there if needed (e.g., @.konductor/memory/MEMORY.md).

Required structure

Author AGENTS.md with these sections, adapted to the project as follows: infer what you can directly from the repo (build files, existing test commands, directory structure, git history for commit-message conventions); ask the user only for what cannot be inferred (e.g., PR/review conventions not visible in the repo, or team-specific domain knowledge). State inferred content as inferred so the user can correct it during review.

  1. Context Loading (MUST follow at session start) — instruction block (see template below)
  2. Project Overview — what the project is, in 2-3 sentences
  3. Project Structure — directory map
  4. Setup & Commands — build, test, install commands
  5. Code Style & Conventions — formatting, naming, language rules; if a .kiro/steering/*.md file already documents these, reference it (See .kiro/steering/<file>.md) rather than duplicating its content
  6. Testing — how to run tests
  7. Workflow — git/PR/CR conventions
  8. Domain Knowledge (optional) — durable project-specific facts

Context-loading instruction block (always include)

Because Kiro does not expand import directives in AGENTS.md, use explicit MUST-read instructions so the agent loads adjacent context via its own file-read tools:

## Context Loading (MUST follow at session start)

Before starting work, load available project context:

- You MUST read `.kiro/steering/**/*.md` if present — workspace steering rules.
- You MUST read `<workspace>/memory/*.md` if present — persistent facts and preferences.
- Workspace-specific skills may exist at `.kiro/skills/**/ws-*.md` — be aware and load when relevant.

If a path does not exist, skip it silently and continue.

Replace <workspace> with the project root (e.g., .konductor), so <workspace>/memory/*.md -> .konductor/memory/*.md.

Rules

  • AGENTS.md is developer-written instructions, NOT agent memory. Do not dump session memory or timestamped facts here — that belongs in the memory files. Promote only durable, reviewed learnings.
  • Keep it concise and scannable — bullets and short sections, not prose.
  • For public packages, keep content generic — no internal tools, domains, or credentials.
  • When asked to edit CLAUDE.md, edit AGENTS.md instead (CLAUDE.md should just @AGENTS.md).

Procedure

  1. Check whether AGENTS.md exists at the repo root. If it does, read it and patch rather than replace.
  2. Draft/update the sections above, always including the Context Loading block.
  3. Ensure a CLAUDE.md exists with @AGENTS.md (create it if missing) for Claude Code compatibility.
  4. Confirm the relevant agent specs list file://AGENTS.md in clientConfig.kiroCli.resources.
  5. Show the proposed content to the user and confirm before writing.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.