Skip to content

Commit 618147e

Browse files
Merge pull request #26 from chainapsis/docs/sync-readme-with-docs
docs: README와 Docs 사이트 내용 동기화
2 parents ea3f674 + 76ce2b0 commit 618147e

5 files changed

Lines changed: 54 additions & 268 deletions

File tree

README.md

Lines changed: 33 additions & 133 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@
33
> [!WARNING]
44
> **Beta Notice:** Keplr Wallet MCP is in beta and may contain bugs or unexpected behavior. By using this software, you acknowledge that you do so at your own risk. The developers are not liable for any loss of funds or damages arising from the use of this software.
55
6-
AI agents can interact with Cosmos ecosystem chains via the [Model Context Protocol](https://modelcontextprotocol.io/).
6+
Your AI-powered wallet for Cosmos. Send, stake, swap — just ask. Currently supporting 40+ chains via the [Model Context Protocol](https://modelcontextprotocol.io/).
7+
8+
For setup guides, usage examples, and full tool reference, see the [Docs](https://mcp.keplr.app/docs).
79

810
## Architecture
911

@@ -12,6 +14,7 @@ This is a **pnpm monorepo** with a plugin-based architecture for multi-ecosystem
1214
| Package | Description |
1315
|---------|-------------|
1416
| `@keplr-wallet/keplr-wallet-mcp` | Core MCP server with Cosmos built-in + account/chain management |
17+
| `@keplr-wallet/biometric-darwin` | macOS biometric authentication binary (private) |
1518

1619
## Prerequisites
1720

@@ -20,14 +23,21 @@ This is a **pnpm monorepo** with a plugin-based architecture for multi-ecosystem
2023

2124
## Quick Start
2225

26+
### Using the published package
27+
2328
```bash
24-
# Install dependencies
25-
pnpm install
29+
# Claude Code
30+
claude mcp add --scope user keplr -- npx @keplr-wallet/keplr-wallet-mcp
2631

27-
# Build all packages
28-
pnpm build
32+
# Or install directly
33+
npm install @keplr-wallet/keplr-wallet-mcp
34+
```
35+
36+
### Development (from source)
2937

30-
# Run the server
38+
```bash
39+
pnpm install
40+
pnpm build
3141
pnpm start
3242
```
3343

@@ -51,16 +61,20 @@ Add to `~/Library/Application Support/Claude/claude_desktop_config.json`:
5161
{
5262
"mcpServers": {
5363
"keplr": {
54-
"command": "node",
55-
"args": ["/path/to/keplr-mcp-server/packages/server/dist/index.js"]
64+
"command": "npx",
65+
"args": ["@keplr-wallet/keplr-wallet-mcp"]
5666
}
5767
}
5868
}
5969
```
6070

6171
### Claude Code
6272

63-
Copy the template and fill in your API keys:
73+
```bash
74+
claude mcp add --scope user keplr -- npx @keplr-wallet/keplr-wallet-mcp
75+
```
76+
77+
For development, copy the template and fill in your API keys:
6478

6579
```bash
6680
cp .mcp.json.example .mcp.json
@@ -114,138 +128,22 @@ Configuration is stored in `~/.keplr-mcp/`.
114128

115129
**Cosmos:** Cosmos Hub, Osmosis, dYdX, Celestia, Stargaze, Juno, Noble, Stride, Akash, Injective, and 40+ more.
116130

117-
## Tool Summary
118-
119-
### Onboarding
120-
- `onboarding-status` — Check wallet setup progress with checklist and next steps
121-
122-
### Account Management
123-
- `list-accounts` — List all accounts with active account marked
124-
- `create-account` — Create new account with generated mnemonic
125-
- `import-account` — Import existing mnemonic as account
126-
- `switch-account` — Switch active account
127-
- `rename-account` — Rename an account
128-
- `delete-account` — Delete account (requires confirmation)
129-
- `get-account-addresses` — Get all addresses for active account
130-
- `export-mnemonic` — Export recovery phrase for an account (requires confirmation)
131-
- `check-vault-health` — Check vault integrity and repair if needed
132-
133-
### Chain Query
134-
- `list-cosmos-chains` — List all supported Cosmos chains
135-
136-
### Cosmos Query
137-
- `get-cosmos-address` — Get wallet address for a chain
138-
- `get-balances` — Query token balances
139-
- `get-staking-info` — View delegations and rewards
140-
- `get-portfolio` — Unified portfolio across all chains with USD values
141-
- `list-validators` — Browse validators with commission and voting power
142-
- `list-proposals` — View governance proposals
143-
- `get-proposal` — Get detailed info about a specific proposal with tally results
144-
- `get-unbonding` — View unbonding delegations with completion times
145-
- `list-fee-tokens` — List accepted fee tokens for a chain with balances
146-
- `list-ibc-channels` — List IBC transfer channels for a chain
147-
148-
### Cosmos Transaction
149-
- `send-tokens` — Send tokens
150-
- `ibc-transfer` — Cross-chain IBC transfer (auto-resolves channels via Skip API)
151-
- `delegate` / `undelegate` / `redelegate` — Manage staking positions
152-
- `claim-rewards` / `claim-all-rewards` — Claim staking rewards
153-
- `vote-governance` — Vote on governance proposals
154-
- `cancel-unbonding` — Cancel unbonding delegation
155-
156-
### Cosmos Signing
157-
- `cosmos-sign-arbitrary` — Sign arbitrary message using ADR-36 (proves address ownership)
158-
- `cosmos-verify-signature` — Verify an ADR-36 signature
159-
160-
### CosmWasm
161-
- `cosmwasm-query` — Query smart contract state
162-
- `cosmwasm-execute` — Execute smart contract
163-
- `cosmwasm-instantiate` — Instantiate a new contract
164-
- `cosmwasm-contract-info` — Get contract metadata
165-
- `cosmwasm-list-contracts` — List contracts deployed from a code ID
166-
167-
### Multi-Action
168-
- `multi-action-create` — Start a multi-action transaction (atomic, saves gas)
169-
- `multi-action-add` — Add an action (send, delegate, vote, cosmwasm-execute, etc.)
170-
- `multi-action-remove` — Remove an action by index
171-
- `multi-action-preview` — Simulate and preview gas/fee estimates
172-
- `multi-action-execute` — Execute all actions atomically
173-
- `multi-action-list` — List pending multi-action transactions
174-
- `multi-action-cancel` — Cancel a multi-action transaction
175-
176-
### DeFi
177-
- `osmosis-quote` / `osmosis-swap` — Osmosis DEX token swaps
178-
179-
### Authentication (Optional)
180-
- `auth-status` — Check authentication configuration and available methods
181-
- `auth-setup` — Setup authentication provider (biometric or TOTP)
182-
- `auth-verify-setup` — Complete TOTP setup with verification code
183-
- `auth-available-methods` — Check available auth methods for an action
184-
- `auth-enable` / `auth-disable` — Enable/disable auth system
185-
- `auth-provider-disable` — Disable specific auth provider
186-
187-
### Keplr Infra
188-
- `keplr_api_configure_key` — Configure a Keplr Infra API key in MCP config (user or project scope)
189-
- `keplr_api_validate_key` — Validate a Keplr Infra API key
190-
- `keplr_api_get_payment_link` — Get a Stripe payment link to add Keplr Infra credits
191-
- `keplr_api_get_usage_summary` — Get Keplr Infra usage summary (balance, requests, per-chain breakdown)
192-
- `keplr_api_get_usage_history` — Get Keplr Infra usage history with date/chain/endpoint filters
193-
- `keplr_api_get_credit_history` — Get Keplr Infra credit transaction history (top-ups, adjustments)
194-
- `keplr_api_list_chains` — List all chains available on Keplr Infra
195-
196-
### Utilities
197-
- `confirm-action` — Execute pending transaction
198-
- `cancel-pending-action` — Cancel a pending transaction
199-
- `list-pending-actions` — View pending confirmation tokens
200-
- `list-transaction-history` — View past transaction history with status
201-
- `get-transaction-status` — Check on-chain transaction status
202-
- `search-tools` — Search tools by keyword, category, or ecosystem
203-
- `describe-tools` — Get full parameter details for specific tools
204-
- `list-installed-adapters` — List loaded ecosystem adapters
205-
206-
### Prompts (Slash Commands)
207-
208-
#### Onboarding & Account
209-
- `/get-started` — Guided onboarding for new users
210-
- `/create-account` — Create new wallet
211-
- `/import-account` — Import existing wallet
212-
- `/delete-account` — Delete a wallet account
213-
- `/switch-account` — Switch active account
214-
- `/list-accounts` — List all accounts
215-
216-
#### Query & Operations
217-
- `/check-balances` — Check token balances
218-
- `/check-staking` — Check staking positions
219-
- `/wallet-overview` — Quick overview of wallet status and addresses
220-
- `/analyze-portfolio` — Analyze cross-chain portfolio with recommendations
221-
- `/send` — Send tokens (guided)
222-
- `/stake` — Guided staking flow
223-
- `/redelegate` — Move stake between validators (guided)
224-
- `/claim-rewards` — Claim staking rewards
225-
- `/governance` — Participate in governance voting (guided)
226-
- `/ibc-transfer` — Transfer tokens between chains (guided)
227-
- `/bridge` — Bridge tokens between Cosmos chains
228-
229-
#### DeFi & Smart Contracts
230-
- `/osmosis-swap` — Swap tokens on Osmosis DEX (guided)
231-
- `/cosmwasm-interact` — Interact with a CosmWasm smart contract (guided)
232-
233-
#### Security & Discovery
234-
- `/setup-authentication` — Configure authentication for transactions
235-
- `/setup-totp` — Setup Google Authenticator 2FA
236-
- `/security-check` — Review wallet security settings
237-
- `/keplr-guide` — Guide for discovering and using tools via meta-tools
131+
## Tools & Prompts
132+
133+
67 tools and 20+ prompts across categories: Account Management, Cosmos Query & Transaction, CosmWasm, Multi-Action, DeFi (Osmosis), Authentication, Keplr Infra, and more.
134+
135+
For the full tool list and parameters, see the [Tool Reference](https://mcp.keplr.app/docs/reference).
238136

239137
## Security
240138

241-
- Mnemonics are stored in the OS Keychain (macOS Keychain, Windows Credential Manager, Linux Secret Service)
242-
- All state-changing operations require explicit confirmation via `confirm-action`
139+
- Mnemonics are encrypted with AES-256-GCM and stored in `~/.keplr-mcp/vaults/<account>.enc`. The decryption key is stored in your OS credential store (e.g. macOS Keychain)
140+
- All transactions (send, delegate, swap, etc.) require explicit confirmation via `confirm-action`
243141
- Confirmation tokens expire after 5 minutes
244142
- Use dedicated wallets with limited funds for AI agent usage
245143

246144
### Optional: Two-Factor Authentication
247145

248-
For additional security, you can enable authentication for destructive actions (e.g., account deletion). Two methods are available:
146+
For additional security, you can enable authentication for destructive actions (account deletion, mnemonic export). Authentication is handled separately from transaction confirmation — it applies at the tool layer, not via `confirm-action`. Two methods are available:
249147

250148
#### Biometric (Touch ID / Face ID)
251149
```
@@ -261,6 +159,8 @@ auth-verify-setup provider=totp code=123456 # Step 2: Verify with 6-digit code
261159

262160
When enabled, you'll need to authenticate before performing protected actions.
263161

162+
TOTP secrets are stored in your OS credential store (e.g. macOS Keychain), not in the config file.
163+
264164
**Supported authenticator apps:** Google Authenticator, Authy, Microsoft Authenticator, 1Password, and any RFC 6238 compatible app.
265165

266166
## License

docs/pages/getting-started/create-your-first-wallet.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Set up your wallet in seconds — just ask your AI assistant.
88

99
> "Create a new Keplr wallet called my-wallet"
1010
11-
**2.** Claude will generate a wallet and store it securely in your OS credential store (e.g. macOS Keychain). You'll see your wallet addresses for Cosmos chains.
11+
**2.** Claude will generate a wallet and store it securely — the mnemonic is encrypted and saved locally, with the decryption key in your OS credential store (e.g. macOS Keychain). You'll see your wallet addresses for Cosmos chains.
1212

1313
**3.** Verify it worked:
1414

@@ -28,7 +28,7 @@ Your new wallet should appear as the active account.
2828
This will leave your mnemonic as plain text in the conversation history. To avoid exposure, use the `KEPLR_MNEMONIC` environment variable instead. See [Environment Variables](/reference/environment#keplr_mnemonic) for details.
2929
:::
3030

31-
**2.** Claude will import the wallet and store it securely in your OS credential store (e.g. macOS Keychain). You'll see your wallet addresses for Cosmos chains.
31+
**2.** Claude will import the wallet and store it securely — the mnemonic is encrypted and saved locally, with the decryption key in your OS credential store (e.g. macOS Keychain). You'll see your wallet addresses for Cosmos chains.
3232

3333
**3.** Verify it worked:
3434

docs/pages/index.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Keplr Wallet MCP
22

3-
Your AI-powered wallet. Send, stake, swap - just ask. Currently supporting 50+ Cosmos chains.
3+
Your AI-powered wallet. Send, stake, swap - just ask. Currently supporting 40+ Cosmos chains.
44

55
:::info[Beta Notice]
66
Keplr Wallet MCP is in beta and may contain bugs or unexpected behavior. By using this software, you acknowledge that you do so at your own risk. The developers are not liable for any loss of funds or damages arising from the use of this software.
@@ -10,14 +10,14 @@ Keplr Wallet MCP is in beta and may contain bugs or unexpected behavior. By usin
1010

1111
Keplr Wallet MCP brings your Cosmos wallet into AI assistants like Claude. Describe what you want in everyday language, and the AI executes it for you.
1212

13-
- **50+ Cosmos chains**: Cosmos Hub, Osmosis, Celestia, and more
13+
- **40+ Cosmos chains**: Cosmos Hub, Osmosis, Celestia, and more
1414
- **Token swaps**: Osmosis DEX
1515

1616
## Key Features
1717

1818
### Multi-Chain Support
1919

20-
50+ Cosmos chains supported out of the box.
20+
40+ Cosmos chains supported out of the box.
2121

2222
<details>
2323
<summary>View all supported chains</summary>
@@ -35,7 +35,7 @@ Ask your AI assistant things like:
3535

3636
### Wallet Security
3737

38-
Your wallet is protected by a **24-word recovery phrase** (mnemonic). The recovery phrase is encrypted and stored in your OS credential store (e.g. macOS Keychain).
38+
Your wallet is protected by a **24-word recovery phrase** (mnemonic). The recovery phrase is encrypted with AES-256-GCM and stored locally. The decryption key is stored in your OS credential store (e.g. macOS Keychain).
3939

4040
## Quick Start
4141

docs/pages/reference/tools/accounts.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ None required.
5858
"tool": "create-account"
5959
},
6060
"setupOptions": [
61-
{ "tool": "create-account", "description": "Generate a new wallet with a fresh mnemonic phrase", "security": "Keys stored in OS Keychain", "ecosystems": ["Cosmos"] },
61+
{ "tool": "create-account", "description": "Generate a new wallet with a fresh mnemonic phrase", "security": "Encrypted locally, decryption key in OS Keychain", "ecosystems": ["Cosmos"] },
6262
{ "tool": "import-account", "description": "Import existing wallet with your mnemonic phrase", "security": "⚠️ Mnemonic visible in chat history - use with caution", "ecosystems": ["Cosmos"] }
6363
]
6464
}
@@ -92,7 +92,7 @@ Response: {
9292
"message": "Next step: Create your first wallet to get started",
9393
"nextAction": { "tool": "create-account" },
9494
"setupOptions": [
95-
{ "tool": "create-account", "description": "Generate a new wallet with a fresh mnemonic phrase", "security": "Keys stored in OS Keychain", "ecosystems": ["Cosmos"] }
95+
{ "tool": "create-account", "description": "Generate a new wallet with a fresh mnemonic phrase", "security": "Encrypted locally, decryption key in OS Keychain", "ecosystems": ["Cosmos"] }
9696
]
9797
}
9898
```
@@ -126,7 +126,7 @@ Generate a new wallet with a BIP39 mnemonic phrase.
126126
"addresses": { "Cosmos": "cosmos1..." },
127127
"warning": "⚠️ This mnemonic was transmitted through your AI provider's servers. Store it in a secure location immediately and consider deleting this conversation.",
128128
"security": {
129-
"storage": "OS Keychain (secure)",
129+
"storage": "Encrypted locally (AES-256-GCM), decryption key in OS Keychain",
130130
"backupRecommendation": "Consider backing up your recovery phrase in a secure location."
131131
},
132132
"nextSteps": [
@@ -158,7 +158,7 @@ Response: {
158158
"addresses": { "Cosmos": "cosmos1..." },
159159
"warning": "⚠️ This mnemonic was transmitted through your AI provider's servers. ...",
160160
"security": {
161-
"storage": "OS Keychain (secure)",
161+
"storage": "Encrypted locally (AES-256-GCM), decryption key in OS Keychain",
162162
"backupRecommendation": "Consider backing up your recovery phrase in a secure location."
163163
},
164164
"nextSteps": [
@@ -221,8 +221,8 @@ If declined, the response includes alternatives:
221221
},
222222
"addresses": { "Cosmos": "cosmos1..." },
223223
"security": {
224-
"storage": "OS Keychain (secure)",
225-
"note": "Your recovery phrase is now stored securely in your system keychain.",
224+
"storage": "Encrypted locally (AES-256-GCM), decryption key in OS Keychain",
225+
"note": "Your recovery phrase is encrypted and stored locally. The decryption key is in your system keychain.",
226226
"warnings": [
227227
"🚨 IMPORTANT: Your mnemonic was provided as a tool parameter and is visible in this conversation",
228228
"🔒 Consider clearing chat history if this is a high-value wallet",

0 commit comments

Comments
 (0)