apm copilot-instructions.md

A set of project rules for the microsoft/apm codebase, including checks for Python style, YAML file handling, file size, duplicated code, and authentication-related signals.

In plain words
What is it for?
Use it when changing apm code or preparing pull requests, release notes, or audit reports. It provides commands for running the project's checks locally and guidance on keeping changes compatible with the main branch.
Why use it?
It helps developers catch the same issues that continuous integration (automated checks run for proposed changes) will reject, before pushing code. It also explains local workflow details and common surprises.

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/copilot-instructions
Clone the repo
git clone --depth 1 https://github.com/microsoft/apm

Made for: GitHub Copilot.

Per session 827 This file is loaded in full into every session.
When invoked 827 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.00827 $0.00827
Opus 5 $0.00413 $0.00413
Sonnet 5 $0.00165 $0.00165
Haiku 4.5 $0.00083 $0.00083

Measured yesterday against content hash 028904d8ec8d, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

apm copilot-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 yesterday.

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.

Origin

Copies of this mod

1 near-identical copy found in the catalogue:

.github/copilot-instructions.md · 69 lines

How it starts

The opening of the file, as written. The whole thing — 69 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Linting (canonical contract)

The CI Lint job is a hard gate. Mirror it locally before git push and before producing any artifact (PR body, release note, audit report) that claims CI is green.

CI-mirror commands

The Lint job runs (see .github/workflows/ci.yml):

  1. uv run --extra dev ruff check src/ tests/
  2. uv run --extra dev ruff format --check src/ tests/
  3. YAML I/O safety guard (rejects raw yaml.dump(..., handle) outside utils/yaml_io.py; mark approved exceptions with # yaml-io-exempt).
  4. File length guardrail (no src/**/*.py may exceed 2450 lines).
  5. No raw str(path.relative_to(...)) patterns -- use portable_relpath() from apm_cli.utils.paths.
  6. Code duplication guardrail (pylint R0801): uv run --extra dev python -m pylint --disable=all --enable=R0801 \ --min-similarity-lines=10 --fail-on=R0801 src/apm_cli/
  7. Auth-protocol boundary check: bash scripts/lint-auth-signals.sh

All seven must succeed. CI evaluates these on the PR merge commit (HEAD merged with current main), so duplication introduced by a recent main commit can fail your PR even if your own diff is clean. Always merge main locally before running the mirror.

Local workflow

  • Auto-fix style+imports: uv run --extra dev ruff check src/ tests/ --fix
  • Apply formatter: uv run --extra dev ruff format src/ tests/
  • Verify the full Lint job (must all be silent / exit 0):
    uv run --extra dev ruff check src/ tests/ \
      && uv run --extra dev ruff format --check src/ tests/ \
      && uv run --extra dev python -m pylint --disable=all --enable=R0801 \
         --min-similarity-lines=10 --fail-on=R0801 src/apm_cli/ \
      && bash scripts/lint-auth-signals.sh
    
    (The YAML, file-length, and relative_to guards are pure-grep one-liners from ci.yml; run them directly if you have touched those surfaces.)

Always run the verify chain before git push -- the CI Lint job fails on any remaining diagnostic.

Read the full file on GitHub · 69 lines

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. yesterday First seen · 69 lines · 827 tokens per session scan A 028904d8ec8d

Subscribe to this mod's changes

apm copilot-instructions.md is an instructions file published in the GitHub repository microsoft/apm (3,668 stars, last pushed yesterday), licensed MIT. It adds 827 tokens to every session, about $0.0041 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.