--- title: "Maintaining AGENTS.md: review, setup & limitations · Undominated.ai" canonical: https://undominated.ai/skills/getsentry-agents-md/ description: "Keeps agent instruction files short and points at existing docs instead of duplicating them." --- # Maintaining AGENTS.md: review, setup & limitations · Undominated.ai > Keeps agent instruction files short and points at existing docs instead of duplicating them. [← Explore all skills](/skills/) DOCUMENTATION AND KNOWLEDGE / Sentry # Maintaining AGENTS.md Keeps agent instruction files short and points at existing docs instead of duplicating them. [See setup guidance ↓](#setup)[Original source ↗](https://github.com/getsentry/skills/tree/d18b7aa8ba878354e5c348310230e652f7690f9c/skills/agents-md) SOURCE REVIEW Reviewed 2026-10-15 Evidence 4 linked sources Publisher Sentry Licence [Apache-2.0 ↗](https://github.com/getsentry/skills/blob/d18b7aa8ba878354e5c348310230e652f7690f9c/LICENSE) Revision d18b7aa8ba87 [Read what was—and wasn’t—checked ↓](#review) “Creates and maintains concise AGENTS.md and CLAUDE.md project instruction files. Use when asked to create AGENTS.md, update AGENTS.md, maintain agent docs, set up CLAUDE.md, document repository agent conventions, or keep coding-agent instructions minimal and reference-backed.” [Sentry · upstream description ↗](https://github.com/getsentry/skills/blob/d18b7aa8ba878354e5c348310230e652f7690f9c/skills/agents-md/SKILL.md) Our analysis follows below. 01 / THE REASONING ## Why this made the selection. - The length cap and the symlink rule are explicit, so the file cannot grow into a second README. - It points at existing docs instead of copying them. ### A good fit for - Creating a root AGENTS.md from lockfiles, CI, and existing docs - Keeping CLAUDE.md as a symlink to that file - Keep repository agent instructions concise while retaining exact authoritative references. - Separate repository-wide instructions from subtree rules when their commands differ. ### Weigh up before choosing - The file must stay at or under 100 lines, with a target under 60. - Divergent AGENTS.md and CLAUDE.md copies are forbidden. - Welcome text, long rationale, and copied README content are listed as anti-patterns. - This review did not execute the skill. - Line budgets are style targets; deleting essential safety or project checks to meet them weakens the contract. Host instruction precedence can differ from the simplified closest-file rule. 02 / THE REVIEW RECORD ## What we actually inspected. Source review has boundaries. A clear record is more useful than a “safe” badge. ### Material inspected - skills/agents-md/SKILL.md - LICENSE - README.md ### Our findings - The pinned skill inspects package manager, commands, and docs before writing, and it creates AGENTS.md at the repository root. - If a Claude entrypoint is required, CLAUDE.md is a symlink to AGENTS.md rather than a second document. - Writing rules require headings and bullets, repo-relative paths, and exact paths to setup, architecture, API, security, and release docs when those files exist. - Project-wide commands are avoided when a file-scoped command exists. - The workflow derives instructions from project evidence and discourages divergent duplicate files, copied policy prose and inventories of installed plugins. - The scope step permits nested AGENTS.md files only for subtrees with different commands or rules, and the verification step checks that referenced paths and commands exist. ### Not established by this review - The skill was not executed inside a host agent. - Not executed: it was not installed or run. The review applies to the material and revision named here. A newer upstream release can change its behavior. 03 / PUT IT TO WORK ## Add a skill to your workflow. [Upstream setup instructions ↗](https://github.com/getsentry/skills/blob/d18b7aa8ba878354e5c348310230e652f7690f9c/README.md) DOCUMENTED COMMAND npx skills add getsentry/skills/skills/agents-md --skill agents-md Copy command ↗ Run in your terminal to choose your AI tools, project or global scope, and installation method. This short command follows the current upstream version; the review covers the revision shown above. Optional: install the reviewed revision Keeps the original source and installer version where recorded, while leaving your AI tools and installation scope for you to choose. npx skills@1.7.1 add https://github.com/getsentry/skills/tree/d18b7aa8ba878354e5c348310230e652f7690f9c/skills/agents-md --skill agents-md Copy reviewed-revision command ↗ - Choose your AI tools and project or global installation scope in Skills CLI. The review applies to the source revision shown on this page. - Retain all supporting files; separately configure companion skills, runtimes and service credentials named in the definition. - Review the resulting diff and use an isolated target before any migration, deployment, load test or warehouse operation. - For manual installation instead, download the complete bundle from https://undominated.ai/resources/skills/getsentry-agents-md/bundle.zip and extract it into a new directory. It holds SKILL.md unchanged at revision d18b7aa8, the upstream licence and an attribution file. - Place the extracted directory in your host's documented skills directory, named agents-md. Keep SKILL.md and the licence together. ### Before you start - Repository write permission and existing commands/policies to preserve. ### Compatibility Agent Skills-compatible hosts ### Local Markdown instructions - Read README, CONTRIBUTING, SECURITY, and CI files - Create AGENTS.md and optionally symlink CLAUDE.md - Writes AGENTS.md and may create a CLAUDE.md symlink; existing instruction ownership and concurrent edits must be preserved. ### Cost model Apache-2.0 licence; no account is named. THE COMPLETE REVIEWED DEFINITION ## Read it before you reuse it. Original source bytes, with attribution. Review the host-specific setup notes above. Copy definition ↗ [Download definition + licence ↗](/resources/skills/getsentry-agents-md/bundle.zip)[Raw Markdown ↗](/resources/skills/getsentry-agents-md/definition.md) --- name: agents-md description: Creates and maintains concise AGENTS.md and CLAUDE.md project instruction files. Use when asked to create AGENTS.md, update AGENTS.md, maintain agent docs, set up CLAUDE.md, document repository agent conventions, or keep coding-agent instructions minimal and reference-backed. --- # Maintaining AGENTS.md Goal: concise, actionable agent instructions. Target under 60 lines; never exceed 100. ## Workflow 1. Inspect before writing: - package manager: lock files and manifests - commands: `package.json`, `Makefile`, task runners, CI workflows - docs/specs/policies: `README.md`, `CONTRIBUTING.md`, `docs/`, `specs/`, `policies/`, `SECURITY.md`, `.github/` - conventions: current code patterns, test layout, generated files, legacy areas to avoid 2. Choose scope: - root `AGENTS.md`: repo-wide defaults - nested `AGENTS.md`: only when a subtree has different commands or rules - closest instruction file wins; keep narrower files shorter than root files 3. Write the smallest useful file. 4. Verify exact paths and commands exist. ## File Setup - Create `AGENTS.md` at the repository root. - If a Claude-compatible entrypoint is required, symlink `CLAUDE.md` to `AGENTS.md`. - Do not maintain divergent `AGENTS.md` and `CLAUDE.md` copies. ## Default Sections Use only sections that add non-obvious value. ````markdown # Agent Instructions ## Package Manager - Use **pnpm**: `pnpm install` ## Commands | Task | Command | |------|---------| | Test file | `pnpm vitest run path/to/file.test.ts` | | Lint file | `pnpm eslint path/to/file.ts` | ## External References | Need | File | |------|------| | Setup | `CONTRIBUTING.md` | | Architecture | `docs/architecture.md` | | Security policy | `SECURITY.md` | ## Key Conventions - Generated files: update with `pnpm generate`; do not edit by hand. ## Commit Attribution AI commits MUST include: ``` Co-Authored-By: (the agent's name and attribution byline) ``` ```` ## Writing Rules - Use headings, bullets, and tables; avoid paragraphs. - Use repo-relative paths; avoid vague references like "see docs". - Reference existing docs/specs/policies instead of copying them. - List exact external files for setup, architecture, API specs, security, release, and policy docs when they exist. - Prefer file-scoped test/lint/typecheck commands; include full builds only when no narrower command exists. - Put commands in tables when there is more than one. - Keep one rule per bullet. - Keep rationale out unless it prevents a likely mistake. - Do not restate linter, formatter, or typechecker config. - Do not list installed skills or plugins. - Do not include generic quality slogans. ## External Reference Rules Good: ```markdown ## External References | Need | File | |------|------| | API contract | `docs/api.md` | | Release process | `docs/releasing.md` | ``` ## Anti-Patterns - welcome text, intros, conclusions, or pleasantries - long prose explaining why instructions matter - duplicated content from `README.md`, `CONTRIBUTING.md`, or policy docs - project-wide commands when file-scoped commands are available - nested `AGENTS.md` files that repeat root instructions The download contains SKILL.md . Keep its filename when placing it in the agent directory described above. By **Sentry**. [Exact upstream source ↗](https://github.com/getsentry/skills/blob/d18b7aa8ba878354e5c348310230e652f7690f9c/skills/agents-md/SKILL.md) · [Licence](/resources/skills/getsentry-agents-md/LICENSE.txt) · [Attribution](/resources/skills/getsentry-agents-md/ATTRIBUTION.txt) SHA-256 8a91ada35068f43ef7ee03e38937863bac4f407878b06f0a4f1ddb4af24bec7e Read the applicable licence Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to the Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS Copyright 2025 Functional Software, Inc. dba Sentry Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. 04 / FOLLOW THE EVIDENCE ## The source trail. Our notes are separate from the original resource. Check upstream before adopting a new version. - [Skill definition ↗](https://github.com/getsentry/skills/blob/d18b7aa8ba878354e5c348310230e652f7690f9c/skills/agents-md/SKILL.md) Checked 2026-10-14 https://github.com/getsentry/skills/blob/d18b7aa8ba878354e5c348310230e652f7690f9c/skills/agents-md/SKILL.md Supports: Workflow and stated scope - [Repository licence ↗](https://github.com/getsentry/skills/blob/d18b7aa8ba878354e5c348310230e652f7690f9c/LICENSE) Checked 2026-10-14 https://github.com/getsentry/skills/blob/d18b7aa8ba878354e5c348310230e652f7690f9c/LICENSE Supports: Redistribution terms - [Install instructions ↗](https://github.com/getsentry/skills/blob/d18b7aa8ba878354e5c348310230e652f7690f9c/README.md) Checked 2026-10-14 https://github.com/getsentry/skills/blob/d18b7aa8ba878354e5c348310230e652f7690f9c/README.md Supports: Documented install path - [Pinned definition review, 2026-10-15 ↗](https://raw.githubusercontent.com/getsentry/skills/d18b7aa8ba878354e5c348310230e652f7690f9c/skills/agents-md/SKILL.md) Checked 2026-10-15 https://raw.githubusercontent.com/getsentry/skills/d18b7aa8ba878354e5c348310230e652f7690f9c/skills/agents-md/SKILL.md Supports: review.findings, bestFor KEEP COMPARING ## Other approaches to consider. Related by category or shared topics. These are alternatives to inspect, not a measured quality order. [### Blog writing guide ↗ Applies one publisher's voice rules, including a banned-language list, and does not pretend that voice is universal.](/skills/getsentry-blog-writing-guide/)[### Documentation and ADRs ↗ Records an architecture decision with a status, instead of leaving the reason in chat.](/skills/addyosmani-documentation-and-adrs/)[### Internal Communications ↗ Formats source-backed team updates, internal newsletters and employee FAQs for a defined audience.](/skills/anthropics-internal-comms/) [AI Tools ↗](/tools/)[Skills ↗](/skills/)[Agents ↗](/agents/)[MCP Servers ↗](/mcp-servers/)[Workflows ↗](/workflows/) ## Continue your investigation - [Choose a toolkit](/tools/) - [Inspect execution hosts](/agents/) - [Check tool access](/mcp-servers/) - [Check project dependencies](/check-repo/)