agent-readiness: Instructions file for GitHub Copilot

.github/copilot-instructions.md

agent-readiness copilot-instructions.md is an instructions file for GitHub Copilot from chevy155/agent-readiness. It costs 634 tokens per session, scanned A, original, MIT.

Project instructions for Agent Readiness, a deterministic Python command-line scanner that checks whether a repository is prepared for AI coding agents. It analyzes files locally without network access or language-model calls.

In plain words
What is it for?
Use it when adding or changing scanner checks, writing tests first, or preserving the project's architecture and excluded-scope rules.
Why use it?
It sets boundaries that keep the scanner predictable, dependency-free at runtime, and focused on repository checks.

Instructions file for GitHub Copilot

Written for GitHub Copilot: a Copilot instructions file. Also seen: mentions Claude Code; mentions AGENTS.md; mentions Cursor.

This is chevy155/agent-readiness's own configuration. It tells GitHub Copilot how to work on agent-readiness itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything agent-readiness configures →

Reuse

Borrowing it

Nothing to install: this file belongs to chevy155/agent-readiness. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/chevy155/agent-readiness/main/.github/copilot-instructions.md
Clone the repo
git clone --depth 1 https://github.com/chevy155/agent-readiness

Made for: GitHub Copilot.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for agent-readiness copilot-instructions.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/chevy155/agent-readiness/copilot-instructions/github.svg)](https://agentmods.dev/instructions/chevy155/agent-readiness/copilot-instructions)
Your own site
<a href="https://agentmods.dev/instructions/chevy155/agent-readiness/copilot-instructions"><img src="https://agentmods.dev/badge/instructions/chevy155/agent-readiness/copilot-instructions/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for agent-readiness copilot-instructions.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/chevy155/agent-readiness/copilot-instructions"><img src="https://agentmods.dev/badge/instructions/chevy155/agent-readiness/copilot-instructions.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 634 This file is loaded in full into every session.
When invoked 634 The same file — it is already loaded in full.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
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.1 $0.00634 $0.00634
Opus 5.5 $0.00254 $0.00254
Sonnet 5.5 $0.00127 $0.00127
Haiku 4.5 $0.00063 $0.00063

Measured 1mo ago against content hash df03e08b6011, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

agent-readiness 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 1mo 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/copilot-instructions.md · 85 lines

How it starts

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

Copilot Instructions — agent-readiness

Instructions for GitHub Copilot, Cursor, Claude Code, and all AI coding agents in this repo.


Project

agent-readiness is the Agent Readiness Scanner — a deterministic Python CLI that checks whether a repository is ready for AI coding agents. It has zero runtime dependencies and makes no network or LLM calls.


Hard Constraints

Keep v0 deterministic. The core scanner (checks.py) must remain pure file-system analysis. Do not add LLM calls, network requests, or probabilistic logic to the check functions.

Keep zero runtime dependencies. agent_readiness/ must import from the standard library only. Dev dependencies (pytest) are fine. Production dependencies are not.

Tests first. Before adding a new check or feature, write a failing test in tests/. Use tmp_path pytest fixture to create isolated test repos.

Do not expand scope. Do not add: SaaS, auth, dashboards, billing, webhooks, telemetry, GitHub App, Slack integration, or any external API. These are future scope items.


Architecture

agent_readiness/
  checks.py    — 17 deterministic check functions, each returns CheckResult TypedDict
  scoring.py   — compute_score(), get_tier(), get_recommendations() — pure math
  report.py    — render_terminal(), render_json(), render_markdown() — pure rendering
  templates.py — generate_agents_md(), generate_copilot_instructions() — file generation
  cli.py       — argparse CLI entry point, calls the above modules

Each module has a single responsibility. Keep it that way.


Style

  • Python ≥ 3.9, type-annotated with from __future__ import annotations
  • TypedDict for structured data (not dataclasses)
  • Functions return values; they do not mutate shared state
  • ANSI color codes in terminal output only — use TIER_COLORS / RESET from scoring.py
  • No print() in library modules (checks.py, scoring.py, report.py, templates.py)
  • CLI output goes through cli.py only

Read the full file on GitHub · 85 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. 1mo ago First seen · 85 lines · 634 tokens per session scan A df03e08b6011

Subscribe to this mod's changes

agent-readiness copilot-instructions.md is an instructions file published in the GitHub repository chevy155/agent-readiness (4 stars, last pushed 5mo ago), licensed MIT. It adds 634 tokens to every session, about $0.0025 per session on Opus 5.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-31.

Related

Other instructions, from other repositories

agent-rulescope tests.instructions.md

Instructions for 13624725933/agent-rulescope, a project described as: See exactly which instructions your coding agent inherits. Scan AGENTS.md, CLAUDE.md, Cursor and Copilot rules.

13624725933/agent-rulescope · 38 tokens

agent-rulescope copilot-instructions.md

Copilot instructions for 13624725933/agent-rulescope, a project described as: See exactly which instructions your coding agent inherits. Scan AGENTS.md, CLAUDE.md, Cursor and Copilot rules.

13624725933/agent-rulescope · 25 tokens

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 9,715 tokens

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,786 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, cache eligibility and rollout and applying the notice (cutover).

microsoft/vscode · 5,262 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,680 tokens