An open API service indexing awesome lists of open source software.

https://github.com/web3auth/web3auth-mcp


https://github.com/web3auth/web3auth-mcp

Last synced: 16 days ago
JSON representation

Awesome Lists containing this project

README

          

# MetaMask Embedded Wallets MCP Server

Build MetaMask Embedded Wallets integrations faster by giving your AI coding assistant live access to the
documentation and deep knowledge of the SDK.

There are two things to set up:

1. **Skill** — Teaches your AI assistant _how to think_ about the SDK: architecture, framework quirks, key derivation rules, and common mistakes. No code in the skill; the MCP provides that.
2. **MCP server** — Gives your AI assistant real-time access to search docs, fetch examples, and look up SDK types.

---

## MCP Tools

| Tool | What it does |
| ------------------- | ---------------------------------------------------- |
| `search_docs` | Search documentation and example projects |
| `get_doc` | Fetch the full content of any doc page |
| `get_example` | Fetch complete source code of an integration example |
| `get_sdk_reference` | Fetch SDK types and hooks from the open-source repos |
| `search_community` | Search the MetaMask Builder Hub for real user issues |

---

## Skill

The skill teaches your AI assistant the mental model for MetaMask Embedded Wallets. It includes SDK selection
logic, key derivation rules, authentication concepts, platform quirks, and common mistakes that aren't obvious
from the docs alone.

> **Tip:** For the best experience, use the MCP server alongside the skill so that your LLM can fetch live docs
> and examples rather than relying on static text.

### Universal install (works with 18+ agents)

```bash
npx skills add Web3Auth/web3auth-mcp --skill web3auth -y
```

The [`skills` CLI](https://skills.sh) by Vercel detects your active AI agent and installs to the right directory automatically — Cursor, Claude Code, Copilot, Kiro, Cline, Codex, Antigravity, and [40+ more](https://skills.sh).

To install globally (available in all projects) or target a specific agent:

```bash
npx skills add Web3Auth/web3auth-mcp --skill web3auth -g -y # global
npx skills add Web3Auth/web3auth-mcp --skill web3auth -a cursor -y # Cursor only
npx skills add Web3Auth/web3auth-mcp --skill web3auth -a claude-code -y # Claude Code only
```

### Cursor

```bash
npx degit Web3Auth/web3auth-mcp/skills/web3auth .cursor/skills/web3auth
```

Cursor picks up any `SKILL.md` inside `.cursor/skills/` automatically and activates it when relevant.

Or install via [Cursor Marketplace](https://cursor.com/marketplace) — search "MetaMask Embedded Wallets".

### Claude Code CLI

```bash
npx degit Web3Auth/web3auth-mcp/skills/web3auth /tmp/web3auth-skill
cat /tmp/web3auth-skill/SKILL.md >> CLAUDE.md
```

### Claude Desktop

Open **Claude Desktop → Settings → Custom Instructions** and paste the contents of [`skills/web3auth/SKILL.md`](./skills/web3auth/SKILL.md) directly.

### Antigravity

```bash
npx degit Web3Auth/web3auth-mcp/skills/web3auth .agent/skills/web3auth
```

Antigravity picks up skills inside `.agent/skills/` automatically. For global installation across all
projects, use `~/.gemini/antigravity/skills/` instead.

### Windsurf / Cline / Kiro / Continue

```bash
npx degit Web3Auth/web3auth-mcp/skills/web3auth .windsurf/skills/web3auth
```

Place the skill in the tool-specific skills directory. Most tools also accept pasting the contents of `SKILL.md` into a system prompt or custom instructions field.

### Other tools

For any LLM tool with a system prompt or custom instructions field, paste the contents of
[`skills/web3auth/SKILL.md`](./skills/web3auth/SKILL.md) directly.

---

## MCP Server Setup

### Cursor

The fastest way is one click:

[![Add MetaMask Embedded Wallets MCP to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en/install-mcp?name=web3auth&config=eyJ1cmwiOiJodHRwczovL21jcC53ZWIzYXV0aC5pbyJ9)

Or install via [Cursor Marketplace](https://cursor.com/marketplace) — search "MetaMask Embedded Wallets".

Or add it manually. Open **Cursor Settings → Tools & Integrations → MCP** and add:

```json
{
"mcpServers": {
"web3auth": {
"url": "https://mcp.web3auth.io"
}
}
}
```

### VS Code (GitHub Copilot)

Install from the Visual Studio Marketplace — search "MetaMask Embedded Wallets", or:

```bash
code --install-extension Web3Auth.metamask-embedded-wallets
```

Or use the one-click install URL:

```
vscode:mcp/install?{"name":"web3auth","url":"https://mcp.web3auth.io"}
```

Or add manually to your workspace `.vscode/mcp.json`:

```json
{
"servers": {
"web3auth": {
"type": "http",
"url": "https://mcp.web3auth.io"
}
}
}
```

### JetBrains (IntelliJ, PyCharm, WebStorm, Android Studio)

Install from the JetBrains Marketplace — search "MetaMask Embedded Wallets".

Or add manually in **Settings → Tools → AI Assistant → Model Context Protocol (MCP)**:

```json
{
"mcpServers": {
"web3auth": {
"url": "https://mcp.web3auth.io",
"transport": "http"
}
}
}
```

### Claude Code CLI

```bash
claude mcp add --transport http web3auth https://mcp.web3auth.io
```

Or add manually to your project's `claude.json`:

```json
{
"mcpServers": {
"web3auth": {
"url": "https://mcp.web3auth.io"
}
}
}
```

### Claude Desktop

Open your Claude Desktop configuration file:

- **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
- **Windows**: `%APPDATA%\Claude\claude_desktop_config.json`

Add the server to the `mcpServers` section:

```json
{
"mcpServers": {
"web3auth": {
"url": "https://mcp.web3auth.io"
}
}
}
```

Restart Claude Desktop and ask: _"Search MetaMask Embedded Wallets docs for React quick start"_ to verify the connection.

### ChatGPT Desktop

Open **ChatGPT Desktop → Settings → Connections** and add a new MCP server:

- **Name**: web3auth
- **URL**: `https://mcp.web3auth.io`

### Windsurf

Open **Windsurf Settings → MCP** and add:

```json
{
"mcpServers": {
"web3auth": {
"serverUrl": "https://mcp.web3auth.io"
}
}
}
```

Or edit `~/.codeium/windsurf/mcp_config.json` directly.

### Kiro (AWS)

Add to your project's `.kiro/settings/mcp.json`:

```json
{
"mcpServers": {
"web3auth": {
"url": "https://mcp.web3auth.io"
}
}
}
```

### Warp Terminal

In Warp, open **Settings → AI → MCP Servers** and click **Add Server**:

- **Name**: web3auth
- **URL**: `https://mcp.web3auth.io`

Or use Warp's one-click MCP install if available in your version.

### Cline (VS Code)

Add to your Cline MCP settings (`Ctrl+Shift+P` → "Cline: Open MCP Settings"):

```json
{
"mcpServers": {
"web3auth": {
"url": "https://mcp.web3auth.io",
"transport": "http"
}
}
}
```

### Continue.dev

Add to your Continue `config.json` (open with `Ctrl+Shift+P` → "Continue: Open config.json"):

```json
{
"mcpServers": [
{
"name": "web3auth",
"url": "https://mcp.web3auth.io"
}
]
}
```

### Zed

Add to your Zed `settings.json` (`Cmd+,` to open):

```json
{
"context_servers": {
"web3auth": {
"command": {
"path": "npx",
"args": ["-y", "mcp-remote", "https://mcp.web3auth.io"]
}
}
}
}
```

Or install via Zed Extensions — search "MetaMask Embedded Wallets".

### Antigravity

Open your MCP configuration file:

- **macOS/Linux**: `~/.config/antigravity/mcp.json`
- **Windows**: `%APPDATA%\antigravity\mcp.json`

Add the server to the `mcpServers` section:

```json
{
"mcpServers": {
"web3auth": {
"url": "https://mcp.web3auth.io"
}
}
}
```

Antigravity hot-reloads MCP config changes — no restart required.

### Xcode (via GitHub Copilot)

Xcode 26.3+ supports MCP via GitHub Copilot. Add the server to your Copilot MCP config or use the VS Code extension setup above (Copilot MCP registry is shared).

Alternatively, configure Xcode's agentic tools to point at `https://mcp.web3auth.io` directly via Settings → Copilot → MCP Servers.

### Eclipse (via GitHub Copilot)

Eclipse with GitHub Copilot supports MCP. Add via **Eclipse → Preferences → GitHub Copilot → MCP Servers → Add Server**:

- **Name**: web3auth
- **URL**: `https://mcp.web3auth.io`

### Neovim (avante.nvim)

In your Lua config, add via [mcphub.nvim](https://github.com/ravitemer/mcphub.nvim):

```lua
require("mcphub").setup({
servers = {
web3auth = {
url = "https://mcp.web3auth.io",
transport = "streamable-http",
},
},
})
```

Or using mcp-remote for compatibility:

```lua
require("avante").setup({
mcp = {
servers = {
web3auth = {
command = "npx",
args = { "-y", "mcp-remote", "https://mcp.web3auth.io" },
},
},
},
})
```

### Neovim (codecompanion.nvim)

```lua
require("codecompanion").setup({
extensions = {
mcp = {
servers = {
web3auth = {
command = "npx",
args = { "-y", "mcp-remote", "https://mcp.web3auth.io" },
},
},
},
},
})
```

### Amp (Sourcegraph)

Add to your Amp MCP configuration:

```json
{
"mcpServers": {
"web3auth": {
"url": "https://mcp.web3auth.io"
}
}
}
```

### Goose

Add to `~/.config/goose/config.yaml`:

```yaml
extensions:
- name: web3auth
type: http
url: https://mcp.web3auth.io
```

### 5ire

In 5ire Settings → MCP Servers → Add:

- **Name**: web3auth
- **URL**: `https://mcp.web3auth.io`

### Aider

Aider supports MCP via the LiteLLM bridge. Add to your Aider config:

```yaml
mcp_servers:
web3auth:
command: npx
args: ["-y", "mcp-remote", "https://mcp.web3auth.io"]
```

### Codex CLI

For Codex CLI or any stdio-only agent, use [mcp-remote](https://github.com/modelcontextprotocol/mcp-remote) to bridge the HTTP endpoint:

```bash
npm install -g mcp-remote
```

Then add to `~/.codex/config.toml`:

```toml
[mcp_servers.web3auth]
command = "npx"
args = ["-y", "mcp-remote", "https://mcp.web3auth.io"]
```

Or add to your agent's JSON config:

```json
{
"mcpServers": {
"web3auth": {
"command": "npx",
"args": ["-y", "mcp-remote", "https://mcp.web3auth.io"]
}
}
}
```

---

## Static docs (llms.txt)

If your AI tool doesn't support MCP yet, use the static documentation file instead:

```
https://docs.metamask.io/llms-full.txt
```

For tools that support the [llms.txt spec](https://llmstxt.org/) and can index docs automatically:

```
https://docs.metamask.io/llms.txt
```

> **Warning:** The static file is a snapshot and may not include the latest updates. Use the MCP server when possible for always-current docs.

---

## Start building

Once the skill and MCP are set up, ask your AI assistant directly. Good starting prompts:

- _"Add MetaMask Embedded Wallets to my React app with Google login."_
- _"Set up social login wallets in my Next.js app using Wagmi."_
- _"Integrate embedded wallets in my Flutter app."_
- _"Why are my users getting different wallet addresses after I changed the login method?"_

> **Tip:** Use planning mode (where available) for your initial prompt. Review the plan before generating code — this
> catches architecture mistakes early and avoids config errors that would change wallet addresses in production.

---

## Distribution

This repo ships artifacts for every major developer platform:

| Platform | Type | Location |
| -------- | ---- | -------- |
| Cursor Marketplace | Plugin | `.cursor-plugin/` + `mcp.json` |
| VS Code Marketplace | Extension | `plugins/vscode/` |
| JetBrains Marketplace | Plugin | `plugins/jetbrains/` |
| Zed Extensions | Extension | `plugins/zed/` |
| Claude Agent SDK | Plugin | `plugins/claude/` |
| Raycast Store | Extension | `plugins/raycast/` |
| ChatGPT GPT Store | Custom GPT | `openai/` |
| Official MCP Registry | `server.json` | `server.json` |
| Glama | `glama.json` | `glama.json` |
| Smithery | Server card | `app/.well-known/mcp/server-card.json/route.ts` |
| Vercel skills.sh | Skill | `skills/web3auth/` |
| agentskill.sh | Skill | `skills/web3auth/` |

---

## Environment Variables

| Variable | Required | Description |
| -------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `GITHUB_TOKEN` | No | GitHub personal access token. Optional but recommended to avoid rate limits when fetching SDK source code via `get_sdk_reference` |

---

## Development

```bash
npm install
npm run build
npm start # Run via stdio
npm run dev # Watch mode
```

## Updating Content

When a product update ships, only a few files need changing:

| What changed | File to update |
| -------------------------------- | --------------------------------- |
| SDK architecture / new gotchas | `skills/web3auth/SKILL.md` |
| New doc pages or URL changes | `src/content/registry.ts` |
| Platform capabilities changed | `src/content/platform-matrix.ts` |
| SDK repo structure changed | `src/content/sdk-registry.ts` |
| New tool category needed | `src/tools/register.ts` |
| Doc page content changed | Nothing (fetched live) |

## License

MIT