apm doc-sync.instructions.md

A set of rules for keeping project documentation aligned with code changes. It covers documentation pages and related reference files, while requiring approval before changing the main README.

In plain words
What is it for?
Use it during code changes that affect documentation, CLI commands, flags, dependencies, authentication, policies, or file formats.
Why use it?
It reduces the risk that instructions, command references, or file-format descriptions become inaccurate after development work.

Instructions file for GitHub Copilot

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/microsoft/apm/doc-sync
Clone the repo
git clone --depth 1 https://github.com/microsoft/apm

Made for: GitHub Copilot.

Per session 345 This file is loaded in full into every session.
When invoked 345 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00345 $0.00345
Opus 5 $0.00172 $0.00172
Sonnet 5 $0.00069 $0.00069
Haiku 4.5 $0.00034 $0.00034

Measured 2d ago against content hash bb3816254f8d, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

apm doc-sync.instructions.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.github/instructions/doc-sync.instructions.md · 15 lines

What it actually says

Rules to keep documentation up-to-date

  • Rule 1: Whenever changes are made to the codebase, it is important to also update the documentation to reflect those changes. You must ensure that the following documentation is updated: Starlight content pages in docs/src/content/docs/. Each page uses Starlight frontmatter (title, sidebar order). Cross-page links use relative paths (e.g., ../../guides/compilation/).

  • Rule 2: The main README.md file is a special case that requires user approval before changes, so, if there is a deviation in the code that affects what is stated in the main README.md file, you must warn the user and describe the drift and README.md update proposal, and wait for confirmation before updating it.

  • Rule 3: Documentation is meant to be very simple and straightforward, we must avoid bloating it with unnecessary information. It must be pragmatic, to the point, succinct and practical.

  • Rule 4: When changing CLI commands, flags, dependency formats, authentication flow, policy schema, or primitive file formats, also update the corresponding resource files in packages/apm-guide/.apm/skills/apm-usage/. Map changes to the correct file: commands.md for CLI changes, dependencies.md for reference formats, authentication.md for token resolution, governance.md for policy schema, package-authoring.md for primitive formats.

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 15 lines · 345 tokens per session scan A bb3816254f8d

Subscribe to this mod's changes

apm doc-sync.instructions.md is an instructions file published in the GitHub repository microsoft/apm (3,668 stars, last pushed 2d ago), licensed MIT. It adds 345 tokens to every session, about $0.0017 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.