agents-md-assistant

Draft AGENTS.md files from repository artifacts using a standard template.

109|40|Updated Jul 24, 2017

Search Tags:#automation #templates #documentation #agents #repository #md

Ready to run

npx skills add https://github.com/dmitriiweb/extract-emails --skill agents-md-assistant

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: agents-md-assistant
Source: https://github.com/dmitriiweb/extract-emails/tree/main/.codex/skills/agents-md-assistant
Command: npx skills add https://github.com/dmitriiweb/extract-emails --skill agents-md-assistant

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Drafts AGENTS.md using a standard template to document repository workflows and agent instructions, reducing manual drafting effort.

Core Features & Use Cases

Inspect repository artifacts such as README.md, CONTRIBUTING.md, and docs to understand goals and workflows.
Pull commands, structure, and workflow rules from build/config files and assemble them into AGENTS.md.
Use references/agents_md_template.md as the base and fill in missing details with TODOs for review.

Quick Start

Run the agent to generate AGENTS.md for your repository.

Frequently Asked Questions about agents-md-assistant

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?▼

Generate an AGENTS.md file by applying a standard template to your repository. The skill inspects README.md, CONTRIBUTING.md, and docs to extract commands, structure, and workflow rules, assembling them into a complete draft.

What is an AGENTS.md file used for in a repository?▼

An AGENTS.md file documents repository workflows and agent instructions. It captures build commands, project structure, and workflow rules to guide automated agents and contributors working within the repository.

Do I need a CONTRIBUTING.md to draft an AGENTS.md file?▼

A CONTRIBUTING.md is not strictly required to draft an AGENTS.md file. The skill uses available artifacts like README.md and docs, automatically inserting TODOs for any missing information needed to complete the template.

How to document repository workflows and agent instructions automatically?▼

Document repository workflows automatically by loading a standard template and populating it with details extracted from your build and config files. The process pulls commands and structure to assemble the final documentation.

What happens if my repository is missing information for the AGENTS.md template?▼

If your repository is missing information for the AGENTS.md template, the skill surfaces TODOs for those specific fields. This highlights gaps in your current documentation for manual review and completion.

Can I use a custom template to generate an AGENTS.md file?▼

The skill generates an AGENTS.md file using its built-in standard template. It fills this base template with extracted repository details rather than supporting custom user-provided templates.