metamask-docs / rules
Cursor rule865 starsChanged 16 days agoApache-2.0View on GitHub
Product-specific guidance for Embedded Wallets documentation, including naming, content organization, and SDK conventions.
We split this product-embedded-wallets.mdc into the rules it gives an agent
3 rules. About 0 are common, 3 are distinctive, and 0 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈3
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: line 12
Use Embedded Wallets (capitalized) as the short form in prose.
- Distinctive: line 16
Do not describe Embedded Wallets as a "wallet." It is embedded wallet infrastructure that developers integrate into their applications.
- Distinctive: line 35
When adding new content, place it in the domain folder that best matches the topic.
≈ “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 Embedded Wallets documentation, including naming, content organization, and SDK conventions. globs: embedded-wallets/**/*.md,embedded-wallets/**/*.mdx alwaysApply: false --- # Embedded Wallets ## Product naming - The product name is **MetaMask Embedded Wallets**. - Use **Embedded Wallets** (capitalized) as the short form in prose. - The SDKs are **MetaMask Embedded Wallet SDKs** (formerly Plug and Play). - Package names and code identifiers still use `web3auth` (for example, `@web3auth/modal`). Do not rename these in code samples. - Do not describe Embedded Wallets as a "wallet." It is **embedded wallet infrastructure** that developers integrate into their applications. ## Content organization Embedded Wallets uses domain-oriented folders rather than strict Diataxis categories: | Folder | Content | |----------------------|--------------------------------------------------| | Root (`README.mdx`) | Product overview and positioning | | `sdk/` | Per-platform integration docs (React, Vue, JS, Node, Android, iOS, React Native, Flutter, Unity, Unreal) | | `authentication/` | Auth methods by type (social, basic, custom) | | `features/` | Product capabilities (MPC, smart accounts, funding, NFT minting, session management) | | `dashboard/` | Developer console and project configuration | | `connect-blockchain/`| Chain-specific connection guides (EVM, Solana, other) | | `infrastructure/` | Architecture and security (MPC, SSS, nodes) | | `migration-guides/` | SDK version upgrade guides (Web, mobile, gaming) | | `troubleshooting/` | Problem/solution pages | When adding new content, place it in the domain folder that best matches the topic. Do not create new top-level folders without discussing with the documentation team. ## SDK documentation - Each platform SDK has its own subfolder under `sdk/` with a consistent structure: `README.mdx`, `usage/` or equivalent, and `advanced/`. - SDK version upgrade guides live under `migration-guides/` (not inside `sdk/`). - Shared SDK snippets live in `sdk/_common/`. Reuse these partials where possible instead of duplicating content. - Chain-specific connection snippets live in `connect-blockchain/` as underscore-prefixed files (for example, `_evm-chains.mdx`). ## Images Embedded Wallets images are stored in `static/img/embedded-wallets/`, not alongside the Markdown source files. Use `@site/static/img/embedded-wallets/...` imports in MDX. ## Sidebar The sidebar configuration is in [ew-sidebar.js](ew-sidebar.js). It groups SDKs by platform category (Web, Mobile and Gaming, Backend) using HTML helpers imported from `./src/utils/w3a-sdk-map.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-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
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.