writing-agents-md

Generate repository-facing AGENTS.md guidance with setup, build, test, and PR rules.

8|Updated Jan 7, 2026
One-click install
npx skills add https://github.com/narumiruna/skills --skill writing-agents-md-narumiruna
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: writing-agents-md
Source: https://github.com/narumiruna/skills/tree/main/skills/writing-agents-md
Command: npx skills add https://github.com/narumiruna/skills --skill writing-agents-md-narumiruna

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps maintainers and teams create clear, repository-facing AGENTS.md guidance that captures project-specific rules, workflows, and quality gates without duplicating human README content.

Core Features & Use Cases

  • Guidance generation: Produce a concise agent-facing repository document that describes setup, build/test commands, code style standards, testing expectations, security considerations, and PR rules.
  • Scope awareness: Handles nested AGENTS.md guidance for monorepos or multi-package projects and ensures scoped instructions stay consistent with the repository evidence.
  • Maintenance enablement: Provides a repeatable template and review prompts to keep AGENTS.md up-to-date as the project evolves.

Quick Start

Provide your repository context and request an AGENTS.md draft tailored to the project.

Frequently Asked Questions about writing-agents-md

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate an AGENTS.md file for my repository?

To generate an AGENTS.md file, provide your repository context to request a tailored draft covering setup, build commands, code style, testing, security, and PR guidelines grounded in your project evidence.

What should I include in AGENTS.md for monorepos or multi-package projects?

AGENTS.md for monorepos should include nested scope awareness, ensuring scoped instructions for sub-packages stay consistent with repository evidence and project-specific rules without duplicating human README content.

How do I write agent-facing coding standards and PR guidelines for my repo?

You can write agent-facing coding standards by generating guidance that captures actionable commands, verification steps, and guardrails for code style, testing expectations, and PR rules specific to your repository.

Does AGENTS.md duplicate the README file in a repository?

AGENTS.md does not duplicate the README; it specifically captures agent-facing repository guidance, project-specific workflows, and quality gates tailored for coding agents rather than human readers.

Can I maintain AGENTS.md guidance as my project evolves?

You can maintain AGENTS.md guidance using a repeatable template and review prompts designed to keep the agent-facing repository instructions up-to-date as your project evolves.

What are the limitations of using AGENTS.md for repo guidance?

AGENTS.md limitations include its strict focus on agent-facing instructions, meaning it requires existing repository evidence to ground actionable commands and guardrails rather than functioning as a general documentation tool.