core AGENTS.md

Repository instructions for AI coding agents working in MetaMask/core, a Yarn-managed monorepo containing multiple packages. They describe its architecture, tools, package layout, and configuration files.

In plain words
What is it for?
Use them to understand the TypeScript stack, package folders, tests, formatting, builds, releases, changelogs, and API documentation in MetaMask/core.
Why use it?
They give an agent the project rules and structure it needs before changing code, reducing mistakes caused by guessing how the repository is organized or tested.

Instructions file for CodexOpenCode

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/metamask/core/agents-md
Clone the repo
git clone --depth 1 https://github.com/MetaMask/core

Made for: Codex, OpenCode.

Per session 3,086 This file is loaded in full into every session.
When invoked 3,086 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.03086 $0.03086
Opus 5 $0.01543 $0.01543
Sonnet 5 $0.00617 $0.00617
Haiku 4.5 $0.00309 $0.00309

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

Security

Grade A, and why

core AGENTS.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.

AGENTS.md · 236 lines

How it starts

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

Guidelines for AI agents

This document provides guidance for AI agents working within this repo.

Architecture

Stack

  • Yarn 4 for managing the monorepo
  • TypeScript 5 for writing type-safe code
  • Jest for writing tests
  • ESLint 9 and Prettier for linting and formatting code
  • Babel for compiling ESM code so that Jest can run it
  • @metamask/auto-changelog for writing and validating changelogs
  • @metamask/create-release-branch, MetaMask/action-publish-release, and MetaMask/action-npm-publish for creating and publishing releases
  • TypeDoc for generating API documentation

Package structure

Yarn workspaces are used to define and manage multiple packages.

Package in this monorepo are represented by subdirectories in packages/. Each directory follows this structure:

  • src/ — Files that get built and published when the package is released. May also contain tests (which do not get published).
  • tests/ — Optional directory that defines helpers or setup for tests.
  • package.json — Defines the name of the package, current version, dependencies, etc.
  • CHANGELOG.md — Each package has a changelog that lists historical changes.
  • README.md — Introduces the package to engineers and provides instructions on how to install and use it.
  • LICENSE — Each package has a license that describes how engineers can use it in projects.
  • Configuration files — See below.

Note that the package template in scripts/create-package/package-template also uses this same structure.

Configuration files

The monorepo uses a hierarchical configuration approach for different tools. For most tools, root-level config files define shared settings, while package-level files extend or customize them.

Contributing teams and codeowners

  • CODEOWNERS defines which GitHub teams own which packages in the monorepo.
  • teams.json instructs the create-update-issues GitHub workflow which labels to assign issues that are created when there are new major version releases of packages.

Read the full file on GitHub · 236 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. 2d ago First seen · 236 lines · 3,086 tokens per session scan A c91a75d99f36

Subscribe to this mod's changes

core AGENTS.md is an instructions file published in the GitHub repository MetaMask/core (413 stars, last pushed 3d ago), licensed MIT. It adds 3,086 tokens to every session, about $0.0154 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.

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 · 6,785 tokens

spec-kit AGENTS.md

AGENTS.md instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,104 tokens

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,182 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,345 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, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens

next.js 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,296 tokens