metamask-docs / rules
Cursor rule869 starsChanged 7 days agoApache-2.0View on GitHub
Product-specific guidance for MetaMask Connect documentation, including terminology, CAIP standards, and content organization.
We split this product-metamask-connect.mdc into the rules it gives an agent
2 rules. About 0 are common, 0 are distinctive, and 2 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈0
Distinctive · estimate
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 13
When referring to the npm package, use the package name in backticks (for example, @metamask/connect-evm).
- Very specific: line 37
When referring to a method or function in prose text, markdown tables, or headings, omit the trailing ().
≈ “Common” is an estimate: at least 1 in 5 of the 6,350 Cursor rule 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.
Files
--- description: Product-specific guidance for MetaMask Connect documentation, including terminology, CAIP standards, and content organization. globs: metamask-connect/**/*.md,metamask-connect/**/*.mdx alwaysApply: false --- # MetaMask Connect ## Product naming - The product name is **MetaMask Connect**. Do not call it "MetaMask SDK." The SDK is the underlying library; MetaMask Connect is the product and documentation brand. - When referring to the npm package, use the package name in backticks (for example, `@metamask/connect-evm`). ## Content organization MetaMask Connect has three sub-areas, each with its own quickstart, guides, and reference: | Sub-area | Path | Focus | |------------|-----------------------------|-------------------------------------------| | EVM | `metamask-connect/evm/` | Ethereum and EVM-compatible chains | | Multichain | `metamask-connect/multichain/` | Cross-chain using CAIP standards | | Solana | `metamask-connect/solana/` | Solana-specific integration | ## CAIP standards (Multichain) Multichain documentation uses Chain Agnostic Improvement Proposals (CAIPs). Use these terms consistently: - **Scopes** (CAIP-2): chain identifiers such as `eip155:1` or `solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp`. - **Account IDs** (CAIP-10): chain-qualified account identifiers such as `eip155:1:0xabc...`. - **Sessions** (CAIP-25): an authorized connection grouping approved scopes and accounts. ## Method references in prose When referring to a method or function in prose text, markdown tables, or headings, omit the trailing `()`. Write `connect`, not `connect()`. This keeps references concise and distinguishes prose names from actual invocations in code blocks. If the reference shows parameters to illustrate usage (for example, `connect(scopes, caipAccountIds)`), keep the parentheses and parameters. ## EVM conventions - Reference the `window.ethereum` provider when discussing the injected provider. - Mention EIP-6963 (Multi Injected Provider Discovery) where relevant for provider detection. ## Sidebar The sidebar configuration is in [mm-connect-sidebar.js](mm-connect-sidebar.js).
Where files are headingNew Cursor rule files have more rules about planning and tracking tasks, and fewer about code style.
Of the Cursor rule files we read, the 3,978 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.
- AGENTS.mdAGENTS.md
- .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-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.
Reviews can't be read right now.
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.