How do I install the Agents Md Generator skill?

Run npx skillmds@latest add knuckles-team/agents-md-generator in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is Agents Md Generator safe to use?

This skill has not completed SkillMD's automated safety review yet. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Agents Md Generator?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Agents Md Generator free to use?

Yes. Installing skills from SkillMD is free. This skill is licensed under MIT.

Who published Agents Md Generator?

Knuckles-Team (@knuckles-team) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Agents Md Generator by knuckles-team

Name: Agents Md Generator
Author: Knuckles-Team

Agents Md Generator

Generate or update a robust AGENTS.md file (the "README for AI coding agents") for a project. This skill ensures your repository is optimized for AI tools (like Copilot, Cursor, and Windsurf) by providing structured context, commands, architecture diagrams, and coding standards. It automatically detects project metadata from pyproject.toml and generates a project tree view.

Knuckles-Team 12be3f0 2 files · 12.6 KB Updated Sep 17, 2026

File contents

AGENTS.md Generator

Generates a robust AGENTS.md file designed specifically for AI coding agents. This file acts as a "README for machines," providing them with the exact project context, rules, and instructions they need to work effectively.

Features

Project Metadata Extraction: Automatically parses pyproject.toml for project name, description, and scripts.
Dynamic File Tree: Generates a text-based tree view of the project structure, ignoring common noise directories (.git, __pycache__, etc.).
Mermaid Diagrams: Includes standardized Architecture and Workflow diagrams to help agents understand the system's design.
Battle-Tested Template: Uses a structure optimized for high agent performance, including "Always/Ask first/Never" boundaries.

Usage

Run the generator script with the path to your project root:

python scripts/generate_agents_md.py <project-path>

Options

<project-path>: (Required) Path to the root directory of the project to document.

AGENTS.md Standard

The generated AGENTS.md follows the emerging open standard for AI agent documentation:

Tech Stack & Architecture: High-level overview of technologies and component interactions.
Commands: Exact, file-scoped commands for building, testing, and linting.
Project Structure: Quick reference to key files and the dynamic tree view.
Code Style & Conventions: Specific "Always" rules with concrete Good/Bad code examples.
Dos and Don'ts: Specific behavioral guidelines.
Safety & Boundaries: Explicit "Always do", "Ask first", and "Never do" constraints.
When Stuck: Instructions on how to handle ambiguity (e.g., "propose a plan first").

---name: agents-md-generatordescription: Generate or update a robust AGENTS.md file (the "README for AI coding agents") for a project. This skill ensures your repository is optimized for AI tools (like Copilot, Cursor, and Windsurf) by providing structured context, commands, architecture diagrams, and coding standards. It automatically detects project metadata from pyproject.toml and generates a project tree view.license: MIT---# AGENTS.md GeneratorGenerates a robust `AGENTS.md` file designed specifically for AI coding agents. This file acts as a "README for machines," providing them with the exact project context, rules, and instructions they need to work effectively.## Features- **Project Metadata Extraction**: Automatically parses `pyproject.toml` for project name, description, and scripts.- **Dynamic File Tree**: Generates a text-based tree view of the project structure, ignoring common noise directories (`.git`, `__pycache__`, etc.).- **Mermaid Diagrams**: Includes standardized Architecture and Workflow diagrams to help agents understand the system's design.- **Battle-Tested Template**: Uses a structure optimized for high agent performance, including "Always/Ask first/Never" boundaries.## UsageRun the generator script with the path to your project root:```bashpython scripts/generate_agents_md.py <project-path>```### Options- `<project-path>`: (Required) Path to the root directory of the project to document.## AGENTS.md StandardThe generated `AGENTS.md` follows the emerging open standard for AI agent documentation:1. **Tech Stack & Architecture**: High-level overview of technologies and component interactions.2. **Commands**: Exact, file-scoped commands for building, testing, and linting.3. **Project Structure**: Quick reference to key files and the dynamic tree view.4. **Code Style & Conventions**: Specific "Always" rules with concrete Good/Bad code examples.5. **Dos and Don'ts**: Specific behavioral guidelines.6. **Safety & Boundaries**: Explicit "Always do", "Ask first", and "Never do" constraints.7. **When Stuck**: Instructions on how to handle ambiguity (e.g., "propose a plan first").

Frequently asked questions