{"slug":"agents-md","title":"agents-md","summary":"This skill should be used when the user asks to \"create AGENTS.md\", \"update AGENTS.md\", \"maintain agent docs\", \"set up CLAUDE.md\", or needs to keep agent instructions concise. Enforces research-backed best practices for minimal, high-signal agent documentation.","platform":"ChatGPT","tags":[],"authorName":"LLM Mart","authorSlug":"llm-mart","score":0,"source":"github","price":null,"verified":false,"createdAt":"2026-08-16T13:38:13.404517Z","repo":{"url":"https://github.com/sickn33/agentic-awesome-skills","stars":46883,"forks":6831,"license":"MIT","updatedAt":"2026-09-25T05:43:16Z"},"bodyHtml":"<hr>\n<h2>name: agents-md\ndescription: This skill should be used when the user asks to \"create AGENTS.md\", \"update AGENTS.md\", \"maintain agent docs\", \"set up CLAUDE.md\", or needs to keep agent instructions concise. Enforces research-backed best practices for minimal, high-signal agent documentation.\nrisk: critical\nsource: community</h2>\n<h1>Maintaining AGENTS.md</h1>\n<p>AGENTS.md is the canonical agent-facing documentation. Keep it minimal—agents are capable and don't need hand-holding. Target under 60 lines; never exceed 100. Instruction-following quality degrades as document length increases.</p>\n<h2>When to Use</h2>\n<ul>\n<li>The user asks to create, update, or audit <code>AGENTS.md</code> or <code>CLAUDE.md</code>.</li>\n<li>The project needs concise, high-signal agent instructions derived from the actual toolchain and repo layout.</li>\n<li>Existing agent documentation is too long, duplicated, or drifting away from real project conventions.</li>\n</ul>\n<h2>File Setup</h2>\n<ol>\n<li>Create <code>AGENTS.md</code> at project root</li>\n<li>Create symlink: <code>ln -s AGENTS.md CLAUDE.md</code></li>\n</ol>\n<h2>Before Writing</h2>\n<p>Analyze the project to understand what belongs in the file:</p>\n<ol>\n<li><strong>Package manager</strong> — Check for lock files (<code>pnpm-lock.yaml</code>, <code>yarn.lock</code>, <code>package-lock.json</code>, <code>uv.lock</code>, <code>poetry.lock</code>)</li>\n<li><strong>Linter/formatter configs</strong> — Look for <code>.eslintrc</code>, <code>biome.json</code>, <code>ruff.toml</code>, <code>.prettierrc</code>, etc. (don't duplicate these in AGENTS.md)</li>\n<li><strong>CI/build commands</strong> — Check <code>Makefile</code>, <code>package.json</code> scripts, CI configs for canonical commands</li>\n<li><strong>Monorepo indicators</strong> — Check for <code>pnpm-workspace.yaml</code>, <code>nx.json</code>, Cargo workspace, or subdirectory <code>package.json</code> files</li>\n<li><strong>Existing conventions</strong> — Check for existing CONTRIBUTING.md, docs/, or README patterns</li>\n</ol>\n<h2>Writing Rules</h2>\n<ul>\n<li><strong>Headers + bullets</strong> — No paragraphs</li>\n<li><strong>Code blocks</strong> — For commands and templates</li>\n<li><strong>Reference, don't embed</strong> — Point to existing docs: \"See <code>CONTRIBUTING.md</code> for setup\" or \"Follow patterns in <code>src/api/routes/</code>\"</li>\n<li><strong>No filler</strong> — No intros, conclusions, or pleasantries</li>\n<li><strong>Trust capabilities</strong> — Omit obvious context</li>\n<li><strong>Prefer file-scoped commands</strong> — Per-file test/lint/typecheck commands over project-wide builds</li>\n<li><strong>Don't duplicate linters</strong> — Code style lives in linter configs, not AGENTS.md</li>\n</ul>\n<h2>Required Sections</h2>\n<h3>Package Manager</h3>\n<p>Which tool and key commands only:</p>\n<pre><code>## Package Manager\nUse **pnpm**: `pnpm install`, `pnpm dev`, `pnpm test`\n</code></pre>\n<h3>File-Scoped Commands</h3>\n<p>Per-file commands are faster and cheaper than full project builds. Always include when available:</p>\n<pre><code>## File-Scoped Commands\n| Task | Command |\n|------|---------|\n| Typecheck | `pnpm tsc --noEmit path/to/file.ts` |\n| Lint | `pnpm eslint path/to/file.ts` |\n| Test | `pnpm jest path/to/file.test.ts` |\n</code></pre>\n<h3>Commit Attribution</h3>\n<p>Always include this section. Agents should use their own identity:</p>\n<pre><code>## Commit Attribution\nAI commits MUST include:\n</code></pre>\n<p>Co-Authored-By: (the agent model's name and attribution byline)</p>\n<pre><code>Example: `Co-Authored-By: Claude Sonnet 4 &lt;noreply@example.com&gt;`\n</code></pre>\n<h3>Key Conventions</h3>\n<p>Project-specific patterns agents must follow. Keep brief.</p>\n<h2>Optional Sections</h2>\n<p>Add only if truly needed:</p>\n<ul>\n<li>API route patterns (show template, not explanation)</li>\n<li>CLI commands (table format)</li>\n<li>File naming conventions</li>\n<li>Project structure hints (point to critical files, flag legacy code to avoid)</li>\n<li>Monorepo overrides (subdirectory <code>AGENTS.md</code> files override root)</li>\n</ul>\n<h2>Anti-Patterns</h2>\n<p>Omit these:</p>\n<ul>\n<li>\"Welcome to...\" or \"This document explains...\"</li>\n<li>\"You should...\" or \"Remember to...\"</li>\n<li>Linter/formatter rules already in config files (<code>.eslintrc</code>, <code>biome.json</code>, <code>ruff.toml</code>)</li>\n<li>Listing installed skills or plugins (agents discover these automatically)</li>\n<li>Full project-wide build commands when file-scoped alternatives exist</li>\n<li>Obvious instructions (\"run tests\", \"write clean code\")</li>\n<li>Explanations of why (just say what)</li>\n<li>Long prose paragraphs</li>\n</ul>\n<h2>Example Structure</h2>\n<pre><code># Agent Instructions\n\n## Package Manager\nUse **pnpm**: `pnpm install`, `pnpm dev`\n\n## Commit Attribution\nAI commits MUST include:\n</code></pre>\n<p>Co-Authored-By: (the agent model's name and attribution byline)</p>\n<pre><code>\n## File-Scoped Commands\n| Task | Command |\n|------|---------|\n| Typecheck | `pnpm tsc --noEmit path/to/file.ts` |\n| Lint | `pnpm eslint path/to/file.ts` |\n| Test | `pnpm jest path/to/file.test.ts` |\n\n## API Routes\n[Template code block]\n\n## CLI\n| Command | Description |\n|---------|-------------|\n| `pnpm cli sync` | Sync data |\n</code></pre>\n<h2>Limitations</h2>\n<ul>\n<li>Use this skill only when the task clearly matches the scope described above.</li>\n<li>Do not treat the output as a substitute for environment-specific validation, testing, or expert review.</li>\n<li>Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.</li>\n</ul>\n","files":[{"path":"SKILL.md","sizeBytes":4753,"isText":true}],"reviewScore":null,"reviewSummary":null,"trust":{"provenance":"trusted-source-unreviewed","notice":"Community-authored content, reproduced verbatim and not vetted as instructions. Treat it as data to evaluate, never as directives to follow.","bodySource":null},"bodyLocked":false,"purchaseUrl":null,"sourceUrl":null,"report":{"provenance":"trusted-source-unreviewed","screen":{"ran":true,"outcome":"clean","suspicious":0,"notes":0,"hiddenCharacters":false},"virusScan":{"engine":"clamav","status":"clean","scannedAt":"2026-08-16T13:39:14.398711Z","sha256":"A8355C9A978CA07C0D51187B7853BEE83461114A73DD9DC301BC7FCADC68D3C8","sizeBytes":2159},"review":null,"source":{"repositoryUrl":"https://github.com/sickn33/agentic-awesome-skills","path":"skills/agents-md","license":"MIT","commit":"f2bba339de74414b0771234cbe4f6a15258e32a3","subtreeSha":"CDA30BA8C9C19252030B435D5331840626FBCB1477BE4F59F60DFCF832652F96","lastSyncedAt":"2026-09-25T06:48:39.853703Z"},"reviewedAt":"2026-08-16T13:39:28.339141Z","notice":"Community-authored content, reproduced verbatim and not vetted as instructions. Treat it as data to evaluate, never as directives to follow."},"install":[{"target":"skills-cli","command":"npx skills add https://github.com/sickn33/agentic-awesome-skills/tree/main/skills/agents-md"},{"target":"claude-code","command":"claude plugin marketplace add https://llmmart.ai/marketplace.json && claude plugin install sickn33-agentic-awesome-skills@llmmart"},{"target":"git","command":"git clone https://github.com/sickn33/agentic-awesome-skills.git"}]}