Agent skill

Agents Md

by henryalouf in henryalouf/ruflow

This skill should be used when the user asks to "create AGENTS.md", "update AGENTS.md", "maintain agent docs", "set up CLAUDE.md", or needs to keep agent instructions concise.

MITAuto-check passedAgent Workflows

Install Agents Md

skills CLI
$ npx skills add henryalouf/ruflow --skill agents-md -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install henryalouf/ruflow agents-md --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/henryalouf/ruflow.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/agents-md .claude/skills/agents-md && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
agents-md
GitHub stars
157
Token cost
~1.1k tokens
SKILL.md length
385 words
Files
1
Skills in repo
13
Repo updated
First seen
Licence
MIT

At a glance

This skill should be used when the user asks to "create AGENTS.md", "update AGENTS.md", "maintain agent docs", "set up CLAUDE.md", or needs to keep agent instructions concise.

  • Works in 2 steps: Create AGENTS.md at project root → Create symlink: ln -s AGENTS.md CLAUDE.md
  • Asks to create AGENTS.md
  • SKILL.md covers When to Use, File Setup, Before Writing and Writing Rules, plus 4 more sections
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Agents Md is an agent skill from henryalouf/ruflow. This skill should be used when the user asks to "create AGENTS.md", "update AGENTS.md", "maintain agent docs", "set up CLAUDE.md", or needs to keep agent instructions concise. Enforces research-backed best practices for minimal, high-signal agent documentation.

Its SKILL.md is about 1.1k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Agent Workflows, covering Agent instruction files. The licence is MIT.

When your agent uses it

  • Asks to create AGENTS.md
  • Update AGENTS.md
  • Maintain agent docs
  • Set up CLAUDE.md

Example prompts

  • “create AGENTS.md”
  • “update AGENTS.md”
  • “maintain agent docs”
  • “/agents-md”

Workflow steps

2 steps, taken from the first numbered list in SKILL.md.

  1. Create AGENTS.md at project root
  2. Create symlink: ln -s AGENTS.md CLAUDE.md

What it can do on your machine

Read from SKILL.md and the folder at commit 568d7a5. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md (its code samples are markdown).

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Agents Md loads about 1.1k tokens when it runs. Until then it costs about 68 tokens; SKILL.md has 385 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~68
When it runs · the whole SKILL.md, loaded when a task matches
~1.1k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from henryalouf/ruflow at commit 568d7a5, republished under its MIT licence (© henryalouf). 385 words, ~1,102 tokens.

Download SKILL.mdSave it as .claude/skills/agents-md/SKILL.md (or your agent's skills folder).
name
agents-md
description
This skill should be used when the user asks to "create AGENTS.md", "update AGENTS.md", "maintain agent docs", "set up CLAUDE.md", or needs to keep agent instructions concise. Enforces research-backed best practices for minimal, high-signal agent documentation.
risk
unknown
source
community

Maintaining AGENTS.md

AGENTS.md is the canonical agent-facing documentation. Keep it minimal—agents are capable and don't need hand-holding. Target under 60 lines; never exceed 100. Instruction-following quality degrades as document length increases.

When to Use

  • The user asks to create, update, or audit AGENTS.md or CLAUDE.md.
  • The project needs concise, high-signal agent instructions derived from the actual toolchain and repo layout.
  • Existing agent documentation is too long, duplicated, or drifting away from real project conventions.

File Setup

  1. Create AGENTS.md at project root
  2. Create symlink: ln -s AGENTS.md CLAUDE.md

Before Writing

Analyze the project to understand what belongs in the file:

  1. Package manager — Check for lock files (pnpm-lock.yaml, yarn.lock, package-lock.json, uv.lock, poetry.lock)
  2. Linter/formatter configs — Look for .eslintrc, biome.json, ruff.toml, .prettierrc, etc. (don't duplicate these in AGENTS.md)
  3. CI/build commands — Check Makefile, package.json scripts, CI configs for canonical commands
  4. Monorepo indicators — Check for pnpm-workspace.yaml, nx.json, Cargo workspace, or subdirectory package.json files
  5. Existing conventions — Check for existing CONTRIBUTING.md, docs/, or README patterns

Writing Rules

  • Headers + bullets — No paragraphs
  • Code blocks — For commands and templates
  • Reference, don't embed — Point to existing docs: "See CONTRIBUTING.md for setup" or "Follow patterns in src/api/routes/"
  • No filler — No intros, conclusions, or pleasantries
  • Trust capabilities — Omit obvious context
  • Prefer file-scoped commands — Per-file test/lint/typecheck commands over project-wide builds
  • Don't duplicate linters — Code style lives in linter configs, not AGENTS.md

Required Sections

Package Manager

Which tool and key commands only:

markdown
## Package Manager
Use **pnpm**: `pnpm install`, `pnpm dev`, `pnpm test`
Show full SKILL.md (151 more words)Show less
File-Scoped Commands

Per-file commands are faster and cheaper than full project builds. Always include when available:

markdown
## File-Scoped Commands
| Task | Command |
|------|---------|
| Typecheck | `pnpm tsc --noEmit path/to/file.ts` |
| Lint | `pnpm eslint path/to/file.ts` |
| Test | `pnpm jest path/to/file.test.ts` |
Commit Attribution

Always include this section. Agents should use their own identity:

markdown
## Commit Attribution
AI commits MUST include:

Co-Authored-By: (the agent model's name and attribution byline)

Example: `Co-Authored-By: Claude Sonnet 4 <noreply@example.com>`
Key Conventions

Project-specific patterns agents must follow. Keep brief.

Optional Sections

Add only if truly needed:

  • API route patterns (show template, not explanation)
  • CLI commands (table format)
  • File naming conventions
  • Project structure hints (point to critical files, flag legacy code to avoid)
  • Monorepo overrides (subdirectory AGENTS.md files override root)

Anti-Patterns

Omit these:

  • "Welcome to..." or "This document explains..."
  • "You should..." or "Remember to..."
  • Linter/formatter rules already in config files (.eslintrc, biome.json, ruff.toml)
  • Listing installed skills or plugins (agents discover these automatically)
  • Full project-wide build commands when file-scoped alternatives exist
  • Obvious instructions ("run tests", "write clean code")
  • Explanations of why (just say what)
  • Long prose paragraphs

Example Structure

markdown
# Agent Instructions

## Package Manager
Use **pnpm**: `pnpm install`, `pnpm dev`

## Commit Attribution
AI commits MUST include:

Co-Authored-By: (the agent model's name and attribution byline)


## File-Scoped Commands
| Task | Command |
|------|---------|
| Typecheck | `pnpm tsc --noEmit path/to/file.ts` |
| Lint | `pnpm eslint path/to/file.ts` |
| Test | `pnpm jest path/to/file.test.ts` |

## API Routes
[Template code block]

## CLI
| Command | Description |
|---------|-------------|
| `pnpm cli sync` | Sync data |

© henryalouf, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in .agents/skills/agents-md of henryalouf/ruflow.

Open the folder on GitHubat commit 568d7a5

Compare with similar skills

Agents Md next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Agents Md compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Agents Md this skillhenryalouf/ruflow157—~1.1kAutomated safety check: PassMIT
Using Agent Skillsaddyosmani/agent-skills103k4 repos~2.4kAutomated safety check: PassMIT
Claude ReflectBayramAnnakov/claude-reflect1.7k2 repos~627Automated safety check: PassMIT
Neat-Freak Knowledge CloseoutKKKKhazix/khazix-skills21k—~1.9kAutomated safety check: PassMIT
Writing For Agentsbestofjs/bestofjs3.1k18 repos~2.7kAutomated safety check: PassMIT
Task Observerrebelytics/one-skill-to-rule-them-all3.2k1 repos~12kAutomated safety check: PassCC-BY-4.0

Similar skills

  • Using Agent Skills

    addyosmani/agent-skills

    Meta-skill for choosing which workflow skill fits the task at hand, plus always-on habits: surface assumptions, stop on confusion, push back, keep it simple and stay in scope.

    103k GitHub starsUsed in 4 repos~2.4k tokens
    Agent WorkflowsAuto-check passed
  • Claude Reflect

    BayramAnnakov/claude-reflect

    Self-learning system that captures corrections during sessions and reminds users to run /reflect to update CLAUDE.md.

    1.7k GitHub starsUsed in 2 repos~627 tokens
    Agent WorkflowsAuto-check passed
  • Neat-Freak Knowledge Closeout

    KKKKhazix/khazix-skills

    Brings project docs, agent rule files, authorized memory and leftover workspace files back in line with what the code and runtime actually do at the end of a work session.

    21k GitHub stars~1.9k tokensUpdated 8 days ago
    Agent WorkflowsAuto-check passed
  • Writing For Agents

    bestofjs/bestofjs

    Writing documents for agents. An agent skill from bestofjs/bestofjs.

    3.1k GitHub starsUsed in 18 repos~2.7k tokens
    Agent WorkflowsAuto-check passed
  • Task Observer

    rebelytics/one-skill-to-rule-them-all

    Monitors task execution for skill improvement opportunities.

    3.2k GitHub starsUsed in 1 repo~12k tokens
    Agent WorkflowsAuto-check passed
  • SkillOpt Sleep Cycle

    microsoft/SkillOpt

    Official

    Runs an on-demand or nightly sleep cycle that reviews past Claude Code sessions and proposes validated updates to CLAUDE.md and skills.

    18k GitHub stars~2.3k tokensUpdated 3 days ago
    Agent WorkflowsAuto-check passed

More from henryalouf/ruflow

All 13 skills in this repo
  • Claimable Postgres

    henryalouf/ruflow

    Provision instant temporary Postgres databases via Claimable Postgres by Neon (pg.new).

    157 GitHub stars~2.4k tokensUpdated 4 mo ago
    Auto-check: notes
  • Run local evaluations for Hugging Face Hub models with inspect-ai or lighteval.

    157 GitHub stars~1.6k tokensUpdated 4 mo ago
    Auto-check passed
  • Train or fine-tune TRL language models on Hugging Face Jobs, including SFT, DPO, GRPO, and GGUF export.

    157 GitHub stars~6.9k tokensUpdated 4 mo ago
    Auto-check passed
  • Train or fine-tune vision models on Hugging Face Jobs for detection, classification, and SAM or SAM2 segmentation.

    157 GitHub stars~7.4k tokensUpdated 4 mo ago
    Auto-check passed
  • SEO Aeo Blog Writer

    henryalouf/ruflow

    Writes long-form blog posts with TL;DR block, definition sentence, comparison table, and 5-question FAQ for SEO ranking and AEO citation.

    157 GitHub stars~1.1k tokensUpdated 4 mo ago
    Auto-check passed
  • SEO Aeo Content Cluster

    henryalouf/ruflow

    Builds a topical authority map with a pillar page, prioritised cluster articles, content types, internal link map, and content gap analysis.

    157 GitHub stars~954 tokensUpdated 4 mo ago
    Auto-check passed

Categories

Questions about Agents Md

What does Agents Md do?

This skill should be used when the user asks to "create AGENTS.md", "update AGENTS.md", "maintain agent docs", "set up CLAUDE.md", or needs to keep agent instructions concise. Agents Md is an agent skill from henryalouf/ruflow.md", or needs to keep agent instructions concise.

When should I use Agents Md?

Agents Md fits situations like: asks to create AGENTS.md; update AGENTS.md; maintain agent docs; set up CLAUDE.md.

How do I install Agents Md in Claude Code?

Run `npx skills add henryalouf/ruflow --skill agents-md -a claude-code`. Or copy the skill folder (.agents/skills/agents-md in henryalouf/ruflow) into .claude/skills/agents-md in your project. Claude Code loads it when a task matches its description.

How do I install Agents Md in Codex?

Run `npx skills add henryalouf/ruflow --skill agents-md -a codex`. Or copy the skill folder (.agents/skills/agents-md in henryalouf/ruflow) into .agents/skills/agents-md in your project. Codex loads it when a task matches its description.

Can I use Agents Md in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add henryalouf/ruflow --skill agents-md -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/agents-md, .gemini/skills/agents-md, .github/skills/agents-md and .opencode/skills/agents-md in your project.

What does Agents Md need to run?

SKILL.md names no scripts, command-line tools or credentials: Agents Md is instructions for the agent only.

Does Agents Md access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Agents Md safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Agents Md use?

Agents Md is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Agents Md use?

About 1.1k tokens (SKILL.md is roughly 4.4k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Agents Md?

Skills that share tags, products or a category with Agents Md: Using Agent Skills (addyosmani/agent-skills, 103k stars), Claude Reflect (BayramAnnakov/claude-reflect, 1.7k stars), Neat-Freak Knowledge Closeout (KKKKhazix/khazix-skills, 21k stars) and Writing For Agents (bestofjs/bestofjs, 3.1k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Agents Md?

henryalouf (a GitHub user) maintains it in henryalouf/ruflow, which has 157 GitHub stars. The repository holds 13 skills in this directory. The repository was last updated on May 18, 2026.

Source: henryalouf/ruflow on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.