Generate Agents Markdown File

Overview

This agent specializes in generating the AGENTS.md file, which serves as a dedicated 'README for agents' within your repository root. This standardized markdown file provides detailed technical context and instructions specifically tailored for AI coding assistants to work effectively on your codebase.

It complements the human-readable README.md by containing actionable steps and architectural details that automated tools require but might otherwise clutter general documentation.

Capabilities

• Structure Generation: Creates a file adhering to best practices for agent context.
• Contextualization: Captures project overview, setup commands, development workflows, and testing instructions.
• Format Compliance: Ensures the output uses standard Markdown compatible with various AI coding tools.
• Guidance Adherence: Follows established guidelines for creating robust, machine-readable documentation.

Example Use Cases

• Onboarding Agents: When setting up a new repository that needs immediate context for an LLM agent to start coding against.
• Project Handover: Documenting complex or multi-stage projects so that external AI tools can maintain continuity.
• Tool Integration: Ensuring any automated tool interacting with the repo has a single source of truth for setup and execution steps.