Agent skill

Agents Md

by agent-substrate in agent-substrate/substrate

“Generates or updates an AGENTS.md file”

— description from SKILL.md by agent-substrate
Apache-2.0Auto-check passedAgent Workflows

Install Agents Md

skills CLI
$ npx skills add agent-substrate/substrate --skill agents-md -a claude-code

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

GitHub CLI
$ gh skill install agent-substrate/substrate 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/agent-substrate/substrate.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
4.5k
Token cost
~635 tokens
SKILL.md length
381 words
Files
1
Skills in repo
6
Repo updated
First seen
Licence
Apache-2.0

At a glance

  • Works in 2 steps: Get the beep from the boop. → Then bop it.
  • SKILL.md covers Key Requirements and Maximize AGENTS.md Performance
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

About this skill

Agents Md is a skill in agent-substrate/substrate (4.5k stars). Its SKILL.md is about 635 tokens. Licence: Apache-2.0.

Workflow steps

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

  1. Get the beep from the boop.
  2. Then bop it.

What it can do on your machine

Read from SKILL.md and the folder at commit 0b91488. 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.

    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 635 tokens when it runs. Until then it costs about 12 tokens; SKILL.md has 381 words of instructions outside code blocks.

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

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 agent-substrate/substrate at commit 0b91488, republished under its Apache-2.0 licence (© agent-substrate). 381 words, ~635 tokens.

Download SKILL.mdSave it as .claude/skills/agents-md/SKILL.md (or your agent's skills folder).
name
agents-md
description
Generates or updates an AGENTS.md file

Generate or update AGENTS.md files in key folders of the project. Ensure the target AGENTS.md file accurately reflects the current status of the code.

Key Requirements

There must always be an AGENTS.md file in the project root. The AGENTS.md file at the root of the project may include the following sections:

  • Project overview
  • Build and test commands
  • Code style guidelines
  • Testing instructions
  • Security considerations

AGENTS.md files in subfolders may be even more concise and specific to those subfolders.

Maximize AGENTS.md Performance

To maximize agent performance and token efficiency, adhere to the following:

Progressive Disclosure

Each AGENTS.md should be short. Approx. 100-150 lines total. Link to a handful of relevant, focused reference documents in the same repo, as needed.

Modularity

While only one AGENTS.md is allowed per folder, you can create an AGENTS.md file in any folder. Rather than putting everything in the root AGENTS.md, move highly specific advice to AGENTS.md in the most relevant folders of the project.

References

When documentation that would have helped you is missing, add references in the docs/ folder found at the project root. When these get out of date, update them.

Workflows

When references describe workflows, the tasks should be described as numbered steps. For example:

  1. Get the beep from the boop.
  2. Then bop it.
Decisions

When there are multiple ways of doing something in the codebase, use a decision table like the following:

QuestionBoopBop
Is foo a bar baz?✅
Is foo a quux?✅
Show full SKILL.md (137 more words)Show less
Real Code Examples

If you think they are particularly good examples, include snippets from actual code in the repo, up to approx. 10 lines in length. These should only be the most relevant examples and representative of patterns that would be good to repeat in future code. Their purpose is to improve code reuse by agents, rather than each agent reinventing the wheel.

Domain Specific Rules

If you think it would help, you can include a few simple domain specific rules. Not too many, or agents will get stuck trying to handle too many rules. A general example of a domain specific rule is "Use a finance-specific numeric type for any financial calculations."

Don't vs. Do

When adding warnings against doing something, also make a concrete suggestion for the correct approach. "Don't do X, do Y instead."

© agent-substrate, Apache-2.0. 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 agent-substrate/substrate.

Open the folder on GitHubat commit 0b91488

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 skillagent-substrate/substrate4.5k—~635Automated safety check: PassApache-2.0
Using Agent Skillsaddyosmani/agent-skills102k4 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
Task Observerrebelytics/one-skill-to-rule-them-all3.2k1 repos~12kAutomated safety check: PassCC-BY-4.0
Writing For Agentsbestofjs/bestofjs3.1k17 repos~2.7kAutomated safety check: PassMIT

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.

    102k 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 6 days ago
    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
  • Writing For Agents

    bestofjs/bestofjs

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

    3.1k GitHub starsUsed in 17 repos~2.7k 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 yesterday
    Agent WorkflowsAuto-check passed

More from agent-substrate/substrate

  • Post Draft Review

    agent-substrate/substrate

    Posts pull request review findings as GitHub draft (pending) inline comments for a human to edit and submit, instead of publishing them straight to the PR author.

    4.5k GitHub stars~2.8k tokensUpdated today
    Auto-check passed
  • Triage Issues

    agent-substrate/substrate

    Triages open GitHub issues by applying the correct labels. An agent skill from agent-substrate/substrate.

    4.5k GitHub stars~2.9k tokensUpdated today
    Auto-check passed
  • Detect Flaky Tests

    agent-substrate/substrate

    Detects flaky Go tests by analyzing GitHub Actions workflow runs across the last 7 days and all PRs — covering both the run-tests job (unit/integration) and the e2e-test job (gVisor and microVM…

    4.5k GitHub stars~3k tokensUpdated today
    Auto-check passed
  • Review Crds

    agent-substrate/substrate

    Reviews CRDs for compliance with Kubernetes API conventions.

    4.5k GitHub stars~228 tokensUpdated today
    Auto-check passed
  • Security Status Report

    agent-substrate/substrate

    Generates a security status report based on docs/threats.json by spinning up sub-agents for each threat to compute a quality score.

    4.5k GitHub stars~524 tokensUpdated today
    Auto-check passed

Categories

Questions about Agents Md

How do I install Agents Md in Claude Code?

Run `npx skills add agent-substrate/substrate --skill agents-md -a claude-code`. Or copy the skill folder (.agents/skills/agents-md in agent-substrate/substrate) 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 agent-substrate/substrate --skill agents-md -a codex`. Or copy the skill folder (.agents/skills/agents-md in agent-substrate/substrate) 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 agent-substrate/substrate --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 Apache-2.0 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 635 tokens (SKILL.md is roughly 2.5k 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, 102k stars), Claude Reflect (BayramAnnakov/claude-reflect, 1.7k stars), Neat-Freak Knowledge Closeout (KKKKhazix/khazix-skills, 21k stars) and Task Observer (rebelytics/one-skill-to-rule-them-all, 3.2k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Agents Md?

agent-substrate (a GitHub organization) maintains it in agent-substrate/substrate, which has 4,459 GitHub stars. The repository holds 6 skills in this directory. The repository was last updated on October 7, 2026.

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