Aptos Blockchain MCP

# ✅ Smithery.ai Deployment Checklist Use this checklist to ensure your Aptos MCP server is ready for deployment to Smithery.ai. ## 📋 Pre-Deployment Checklist ### ✅ Code Preparation - [ ] All TypeScript code compiles without errors (`npm run build`) - [ ] All tests pass (`node test-mcp.js`) - [ ] No hardcoded private keys in source code - [ ] `.gitignore` excludes `node_modules`, `.env`, and build artifacts - [ ] All required files are present: - [ ] `package.json` with proper metadata - [ ] `smithery.yaml` configuration - [ ] `README.md` documentation - [ ] `LICENSE` file - [ ] `build/` directory with compiled code ### ✅ GitHub Repository - [ ] Repository is public (required for Smithery) - [ ] All code is committed and pushed - [ ] Repository has a clear name (e.g., `aptos-mcp`) - [ ] Repository description explains the purpose - [ ] No sensitive information in commit history ### ✅ Smithery Configuration - [ ] `smithery.yaml` exists in repository root - [ ] Configuration schema includes required fields: - [ ] `aptosMcpPrivateKey` (required) - [ ] `aptosMcpNetwork` (optional, defaults to testnet) - [ ] Example configuration is provided - [ ] Command function properly maps config to environment variables ### ✅ Documentation - [ ] `README.md` explains what the server does - [ ] Available tools are documented with examples - [ ] Environment variables are explained - [ ] Usage instructions are clear - [ ] Smithery deployment instructions are included ## 🚀 Deployment Steps ### Step 1: Final Preparation ```bash # Run the preparation script ./prepare-deployment.sh # Should show: "Your Aptos MCP server appears ready for deployment!" ``` ### Step 2: GitHub Setup ```bash # Initialize git (if not already done) git init # Add all files git add . # Commit git commit -m "Initial commit: Aptos MCP server for Smithery.ai" # Add remote (replace with your GitHub username) git remote add origin https://github.com/YOUR_USERNAME/aptos-mcp.git # Push to GitHub git push -u origin main ``` ### Step 3: Smithery Registration 1. Go to [smithery.ai](https://smithery.ai) 2. Sign up/login with GitHub 3. Grant repository access permissions 4. Click "New Server" or "Add Server" 5. Select your `aptos-mcp` repository ### Step 4: Server Configuration Fill in the server details: - **Name**: `Aptos Blockchain MCP` - **Description**: `MCP server for Aptos blockchain operations - create accounts, transfer APT, check balances, and query transactions on testnet and mainnet` - **Tags**: `aptos`, `blockchain`, `web3`, `cryptocurrency`, `testnet`, `mainnet` - **Category**: `Blockchain` or `Developer Tools` ### Step 5: Deploy 1. Go to the "Deployments" tab 2. Click "Deploy" 3. Wait for build to complete (2-5 minutes) 4. Verify deployment shows "✅ Deployed" ### Step 6: Test Deployment 1. Use Smithery's test interface 2. Configure with test parameters: ```json { "aptosMcpPrivateKey": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef", "aptosMcpNetwork": "testnet" } ``` 3. Test tools: - `create_account` - Should generate new account - `get_apt_balance` with address `0x1` - Should return balance - `get_account_info` with address `0x1` - Should return account info ## 🔧 Configuration Schema Your deployed server will accept these parameters: ### Required Parameters - **`aptosMcpPrivateKey`** (string): Aptos private key in hex format (starts with 0x) ### Optional Parameters - **`aptosMcpNetwork`** (string): Network to use (`testnet` or `mainnet`, default: `testnet`) - **`aptosMcpNodeUrl`** (string): Custom Aptos node URL (optional) - **`aptosMcpFaucetUrl`** (string): Custom faucet URL for testnet (optional) ## 🎯 Post-Deployment ### ✅ Verification - [ ] Server appears in Smithery registry - [ ] All tools are discoverable - [ ] Test configuration works - [ ] Documentation is accessible - [ ] Server responds to requests ### ✅ Integration Testing - [ ] Test with Claude Desktop integration - [ ] Verify tools work with real Aptos accounts - [ ] Test error handling with invalid inputs - [ ] Confirm network switching works (testnet/mainnet) ### ✅ Monitoring - [ ] Check Smithery dashboard for usage stats - [ ] Monitor for error reports - [ ] Watch for user feedback - [ ] Keep dependencies updated ## 🔄 Updates and Maintenance ### For Code Updates: 1. Make changes to your code 2. Test locally (`node test-mcp.js`) 3. Commit and push to GitHub 4. Go to Smithery Deployments tab 5. Click "Redeploy" ### For Configuration Updates: 1. Update `smithery.yaml` 2. Test the configuration locally 3. Commit and push changes 4. Redeploy on Smithery ## 🆘 Troubleshooting ### Common Issues: **Build Fails on Smithery:** - ✅ Check that `npm run build` works locally - ✅ Ensure all dependencies are in `package.json` - ✅ Verify TypeScript configuration is correct **Server Won't Start:** - ✅ Check `smithery.yaml` syntax - ✅ Ensure `build/index.js` exists and is executable - ✅ Verify environment variable mapping **Tools Don't Work:** - ✅ Test with valid Aptos private key - ✅ Check network connectivity (testnet/mainnet) - ✅ Verify tool parameters match schema **Configuration Errors:** - ✅ Check `configSchema` in `smithery.yaml` - ✅ Ensure required fields are marked correctly - ✅ Test with example configuration ## 📞 Getting Help - **Smithery Discord**: [discord.gg/Afd38S5p9A](https://discord.gg/Afd38S5p9A) - **Smithery Docs**: [smithery.ai/docs](https://smithery.ai/docs) - **Aptos Discord**: [discord.gg/aptoslabs](https://discord.gg/aptoslabs) - **GitHub Issues**: Create issues in your repository ## 🎉 Success Metrics Your deployment is successful when: - ✅ Server builds and deploys without errors - ✅ All tools are discoverable and functional - ✅ Users can configure and use the server - ✅ Documentation is clear and helpful - ✅ Server appears in Smithery's public registry **Congratulations! Your Aptos MCP server is now available to AI applications worldwide! 🌍**