index: Instructions file for GitHub Copilot

.github/instructions/pr-reviewer.instructions.md

index pr-reviewer.instructions.md is an instructions file for GitHub Copilot from indexnetwork/index. It costs 590 tokens per session, scanned A, original, MIT.

A code-review rule set for the indexnetwork/index project. It checks architecture, TypeScript usage, database changes, migrations, and version updates.

In plain words
What is it for?
Use it when reviewing pull requests for controller, service, agent, protocol, TypeScript, Drizzle database, migration, and package-version changes.
Why use it?
It catches unsafe dependencies between project layers, weak type usage, invalid agent inputs, and database update mistakes.

Instructions file for GitHub Copilot

Written for GitHub Copilot: a Copilot instructions file.

This is indexnetwork/index's own configuration. It tells GitHub Copilot how to work on index 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 index configures →

Reuse

Borrowing it

Nothing to install: this file belongs to indexnetwork/index. 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/indexnetwork/index/dev/.github/instructions/pr-reviewer.instructions.md
Clone the repo
git clone --depth 1 https://github.com/indexnetwork/index

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 index pr-reviewer.instructions.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/indexnetwork/index/pr-reviewer/github.svg)](https://agentmods.dev/instructions/indexnetwork/index/pr-reviewer)
Your own site
<a href="https://agentmods.dev/instructions/indexnetwork/index/pr-reviewer"><img src="https://agentmods.dev/badge/instructions/indexnetwork/index/pr-reviewer/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 index pr-reviewer.instructions.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/indexnetwork/index/pr-reviewer"><img src="https://agentmods.dev/badge/instructions/indexnetwork/index/pr-reviewer.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 590 This file is loaded in full into every session.
When invoked 590 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.00590 $0.00590
Opus 5.5 $0.00236 $0.00236
Sonnet 5.5 $0.00118 $0.00118
Haiku 4.5 $0.00059 $0.00059

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

Security

Grade A, and why

index pr-reviewer.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 16d 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/pr-reviewer.instructions.md · 42 lines

How it starts

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

Architecture Layering

  • Flag any controller that imports directly from an adapter (e.g. drizzle.ts, database.adapter.ts) — controllers must delegate to services only.
  • Flag any service that imports another service — use events, queues, or shared lib for cross-service orchestration.
  • Flag any agent file that imports from the database schema or adapters — agents must remain pure and receive dependencies via constructor injection.
  • Flag any @indexnetwork/protocol package code that imports from the app layer (services/api/src/) — the protocol package must be fully self-contained.

TypeScript

  • Flag any use of any type — use unknown and narrow, or a concrete type.
  • Flag agent input/output types not validated with Zod schemas.
  • Flag manual type definitions where Drizzle inference ($inferSelect, $inferInsert) would suffice.
  • Flag imports from lib/schema — always import from src/schemas/database.schema.ts.

Optional / Nullable Columns in Drizzle Upserts

  • When an upsert writes an optional column as col: value ?? null or col: value ?? undefined, check whether this clobbers an existing non-null value on the conflict update path. The preferred pattern is a conditional spread: ...(value !== undefined ? { col: value } : {}) — this omits the column entirely when omitted by the caller, so the DB default or existing row value is preserved.
  • This applies equally to .values() and .set() in .onConflictDoUpdate().

Database & Migrations

  • Flag any migration file that does not follow the naming pattern {NNNN}_{action}_{target}[_{detail}].sql (e.g. 0001_add_chat_session_share_token.sql).
  • Flag hard deletes (DELETE FROM or Drizzle .delete()) in service code where soft deletes (deletedAt) should be used instead.
  • Flag schema changes in database.schema.ts that lack a corresponding new migration file.

Version Bumping

  • Flag changes to packages/cli/ or packages/protocol/ that lack a version bump in their respective package.json.

Read the full file on GitHub · 42 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. 16d ago Changed · -2 tokens per session a7674d19548b
  2. 2mo ago First seen · 42 lines · 592 tokens per session scan A 7812fb893764

Subscribe to this mod's changes

index pr-reviewer.instructions.md is an instructions file published in the GitHub repository indexnetwork/index (145 stars, last pushed today), licensed MIT. It adds 590 tokens to every session, about $0.0024 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-30.

Related

Other instructions, from other repositories

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,461 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

vscode copilot-instructions.md

Copilot instructions for microsoft/vscode, covering vs code copilot instructions, project overview, root folders, core architecture (src/ folder) and built-in extensions (extensions/ folder).

microsoft/vscode · 2,731 tokens

deepseek-harness AGENTS.md

AGENTS.md instructions for deepseek-ai/deepseek-harness, covering agents.md, pre-stable apis and released session data, repository layout, commands and host sandbox failures.

deepseek-ai/deepseek-harness · 4,261 tokens