> For the complete documentation index, see [llms.txt](https://docs.wallet-agent.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.wallet-agent.ai/readme.md). # Introduction ![WalletAgent](https://wallet-agent.ai/og-image.png) [![CI](https://github.com/wallet-agent/wallet-agent/actions/workflows/ci.yml/badge.svg)](https://github.com/wallet-agent/wallet-agent/actions/workflows/ci.yml) [![codecov](https://codecov.io/gh/wallet-agent/wallet-agent/graph/badge.svg)](https://codecov.io/gh/wallet-agent/wallet-agent) **WalletAgent** is an MCP (Model Context Protocol) server that enables Web3 wallet interactions in AI tools like Claude Code and Cursor. It provides safe testing with mock wallets and real wallet support via secure private key management. ## What is WalletAgent? WalletAgent enhances AI coding agents with Web3 development capabilities by providing: * 🔐 **Secure Wallet Management** - Mock wallets for testing, encrypted private keys for real use * ⛽ **Contract Testing** - Simulate contract calls without spending gas * 🔗 **Multi-chain Support** - Works with Ethereum, Polygon, and major EVM chains * 📋 **Wagmi Integration** - Extract, analyze, and test smart contract ABIs * 🛡️ **Security First** - Private keys never logged, comprehensive validation * 🤖 **AI-Native** - Prompts for complex Web3 operations {% hint style="warning" %} **Beta Software Warning** This is beta software under active development. **DO NOT use on mainnet or with wallets containing real funds.** This software has not been audited and may contain bugs that could result in loss of funds. Use only on testnets or local development environments. {% endhint %} ## Quick Navigation ### 🚀 [Getting Started](/getting-started/getting-started.md) New to WalletAgent? Start here to set up the MCP server with your AI agent. ### 👤 [User Guide](/basic-operations/user-guide.md) Learn how to perform wallet operations, send transactions, and manage tokens using prompts. ### 🔧 [Developer Guide](/smart-contract-development/developer-guide.md) Build and test smart contracts, integrate with Wagmi, and extend WalletAgent's capabilities. ### 📚 [API Reference](/api-reference/api-reference.md) Complete reference for all AI agent tools and conversational commands. ### ⚡ [Advanced Topics](/advanced-topics/advanced.md) Encrypted key management, advanced features, Hyperliquid integration, and extending functionality. ## Key Features ### Safe Development Environment * **Mock Wallets**: Pre-configured test accounts for safe development * **Contract Simulation**: Test functions without gas costs using `eth_call` * **Anvil Integration**: Local blockchain for accurate testing ### Production-Ready Security * **Encrypted Key Storage**: AES-256-GCM with PBKDF2 key derivation * **Session Management**: 30-minute timeouts with automatic key clearing * **Environment Variables**: Secure private key loading from files or env vars ### Comprehensive Web3 Toolkit * **Multi-chain Support**: Ethereum, Polygon, major EVM chains * **Token Operations**: ERC-20 transfers, approvals, balance checks * **NFT Management**: ERC-721 transfers and metadata * **Contract Testing**: Automated scenario generation and validation * **Wagmi Integration**: ABI extraction, function analysis, standard detection ### AI-Optimized Experience * **Prompts**: "Send 100 USDC to 0x..." instead of complex function calls * **Rich Feedback**: Detailed transaction previews and error explanations * **User Instructions**: Customize behavior with plain English preferences * **Context Aware**: Remembers wallet state and provides relevant suggestions ## Example Workflows ### Basic Wallet Operations ``` "Connect to 0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266" "Check my balance" "Send 0.1 ETH to shanev.eth" "Switch to Polygon" ``` ### Smart Contract Operations ``` "Load my contract configuration for AI interactions" "Test the transfer function on my token contract" "Check the balance of a specific account" "Simulate minting an NFT before executing the transaction" ``` ### Token Management ``` "Transfer 100 USDC to 0x..." "Get my DOGE balance" "Approve unlimited USDC spending for 0xDEX..." ``` ## Supported AI Tools ### Claude Code ```bash claude mcp add wallet-agent bunx wallet-agent@latest ``` ### Cursor Configure in your MCP settings to enable Web3 operations through prompts with Cursor's AI agent. ## Community & Support * **GitHub**: [wallet-agent/wallet-agent](https://github.com/wallet-agent/wallet-agent) * **Issues**: [Report bugs or request features](https://github.com/wallet-agent/wallet-agent/issues) * **Discussions**: Community support and questions * **Documentation**: You're reading it! 📖 ## What's Next? 1. [**Install WalletAgent**](/getting-started/installation.md) in your AI agent 2. [**Follow the Quick Start**](/getting-started/quick-start.md) guide 3. [**Explore the User Guide**](/basic-operations/user-guide.md) for common operations 4. [**Dive into Development**](/smart-contract-development/developer-guide.md) for advanced features *** Ready to enhance your AI agent with Web3 capabilities? Let's get started. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.wallet-agent.ai/readme.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.