AgentSkillsCN

agents-md-assistant

根据标准模板，对仓库进行检查并起草 AGENTS.md 文件，完整记录命令、结构与工作流程规范。

SKILL.md
--- frontmatter
name: agents-md-assistant
description: Inspect a repository and draft an AGENTS.md file using the standard template, capturing commands, structure, and workflow rules.

AGENTS.md Assistant

Quick start

  • •Review README.md, CONTRIBUTING.md, and docs/CI configs to learn the intended workflow.
  • •Pull exact commands from build scripts (Makefile, package.json, pyproject.toml, justfile).
  • •Map key directories (source, tests, docs, scripts) and mark generated or vendor paths.
  • •Capture architecture: key entrypoints, components, and configuration locations.
  • •If the repo is new/almost empty (little/no docs, no build configs, few files), ask the user what the project is for and the key points (stack, workflows, structure, conventions) before drafting AGENTS.md.
  • •Fill unknowns with TODOs and confirm them with the user.

Workflow

  1. •

    Inspect the repository

    • •Read README.md, CONTRIBUTING.md, and /docs for goals and workflows.
    • •Check build/config files: Makefile, package.json, pyproject.toml, justfile, Dockerfile, CI pipelines.
    • •If the repo is new/almost empty, pause inspection and ask targeted questions to gather: project purpose, tech stack, primary commands (setup/dev/test/lint/build), expected directory layout, and any non-obvious rules (generated paths, formatting, branching/review expectations).
  2. •

    Extract commands

    • •Record install, dev, lint, format, typecheck, test, and build commands exactly as documented.
    • •If multiple options exist, capture the preferred default and note alternates. If something is missing or unclear, ask follow-up questions rather than guessing.
  3. •

    Map structure

    • •Identify primary code, tests, docs, scripts, and generated/ignored folders.
    • •Note where key configs live and any build artifacts to avoid editing.
  4. •

    Summarize architecture & environment

    • •Document key components, data flow, and entrypoints.
    • •Capture required versions, services, env vars, and migration/seed steps.
  5. •

    Author AGENTS.md

    • •Use references/agents_md_template.md as the base.
    • •Place AGENTS.md at the repo root unless instructed otherwise.
    • •Flag missing info with TODOs and ask for confirmation; if key information is missing or unclear, ask additional questions to resolve it.

Reference

  • •references/agents_md_template.md: base template to fill.