MetaMaskMetaMask/metamask-docs/AGENTS.md

metamask-docs

AGENTS.md865 starsChanged 16 days agoApache-2.0View on GitHub

This repository contains the source for docs.metamask.io, the MetaMask developer documentation site. It is built with Docusaurus and covers multiple products aimed at dapp developers and wallet extension builders. Infura API and dashboard documentation lives at Infura documentation in the Infura docs repository. Follow these guides when writing or editing documentation: The rules under .cursor/rules/ cover the most actionable parts of these references. See CONTRIBUTING.md for the full contribution workflow. 1. Do not invent API behavior. Never state as fact…

We split this AGENTS.md into the rules it gives an agent

2 rules. About 0 are common, 2 are distinctive, and 0 are very specific to this project.

≈0
Common · estimate
Many files like this have a rule of this kind.
≈2
Distinctive · estimate
This author's own choices. Worth a look.
0
Very specific
Tied to their project's names, files or tools. Probably skip.

Common
Distinctive
Very specific

Distinctive:
Follow these guides when writing or editing documentation:
line 26
Distinctive:
Do not invent API behavior: Never state as fact any API parameter, return value, or behavior that you have not verified against the …
line 43

≈ “Common” is an estimate: at least 1 in 5 of the 36,368 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.

Files

AGENTS.md

MetaMask developer documentation

Products

Product	Path	Sidebar file	Description
MetaMask Connect	`metamask-connect/`	`mm-connect-sidebar.js`	Connect dapps to MetaMask extension and mobile, across EVM, Solana, and multichain.
Embedded Wallets	`embedded-wallets/`	`ew-sidebar.js`	Embed wallet functionality directly into applications.
Smart Accounts Kit	`smart-accounts-kit/`	`gator-sidebar.js`	Create smart accounts with delegated permissions, and request advanced permissions.
Agent Wallet	`agent-wallet/`	`agent-wallet-sidebar.js`	Give AI agents programmatic wallet access via the `mm` CLI with mandatory security.
Agent Wallet	`agent-wallet/`	`agent-wallet-sidebar.js`	Give AI agents programmatic wallet access via the `mm` CLI with mandatory security.
Snaps	`snaps/`	`snaps-sidebar.js`	Extend MetaMask by creating custom mini-apps.

Infura API and dashboard documentation lives at Infura documentation in the Infura docs repository.

Editorial standards

Follow these guides when writing or editing documentation:

Diataxis framework for content structure

The rules under .cursor/rules/ cover the most actionable parts of these references. See CONTRIBUTING.md for the full contribution workflow.

Critical rules

Do not invent API behavior. Never state as fact any API parameter, return value, or behavior that you have not verified against the codebase or published reference. If you are uncertain, flag it for review.
Respect product boundaries. Each product has its own documentation tree and sidebar. Do not move content across product boundaries without explicit approval from the documentation team.
Use the canonical terminology. See .cursor/rules/terminology.mdc for the required spelling and casing of product and industry terms.
Verify before publishing. Preview changes locally with npm start before requesting review.
Pass the CI linter. PRs are checked by a Vale-based linter that enforces Microsoft style and Consensys terminology. Fix warnings before requesting review.

AI guidance

Detailed editorial, formatting, and product-specific rules are in .cursor/rules/. These rules apply automatically when you edit files matching their glob patterns.

Agent skills live under .cursor/skills/<skill-name>/SKILL.md. This repo includes author-page (scaffold and draft new pages) and style-review (editorial compliance before PR). Cursor loads these when the task matches each skill's description.

Download now (ZIP)

Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.
Of the AGENTS.md files we read, the 28,693 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repository15 other files it gives its agents.
- .cursor/rules/content-types.mdcCursor rule
- .cursor/rules/contributor-workflow.mdcCursor rule
- .cursor/rules/editorial-voice.mdcCursor rule
- .cursor/rules/markdown-formatting.mdcCursor rule
- .cursor/rules/product-agent-wallet.mdcCursor rule
- .cursor/rules/product-embedded-wallets.mdcCursor rule
- .cursor/rules/product-infura.mdcCursor rule
- .cursor/rules/product-metamask-connect.mdcCursor rule
- .cursor/rules/product-smart-accounts-kit.mdcCursor rule
- .cursor/rules/product-snaps.mdcCursor rule
- .cursor/rules/terminology.mdcCursor rule
- .cursor/rules/vercel-redirects.mdcCursor rule
- static/llms.txtllms.txt
- author-pageSkill
- style-reviewSkill

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

It worked
Partly
It didn't

What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free