- Home
- MCP servers
- Aptos
Aptos
- javascript
0
GitHub Stars
javascript
Language
7 months ago
First Indexed
3 months ago
Catalog Refreshed
Documentation & install
Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.
Installation
Add the following to your MCP client configuration file.
Configuration
View docs{
"mcpServers": {
"punkpeye-aptos-mcp": {
"command": "node",
"args": [
"/path/to/aptos_mcp/build/index.js"
],
"env": {
"APTOS_MCP_NETWORK": "testnet",
"APTOS_MCP_NODE_URL": "https://fullnode.testnet.aptos.dev",
"APTOS_MCP_FAUCET_URL": "https://faucet.testnet.aptos.dev",
"APTOS_MCP_PRIVATE_KEY": "YOUR_PRIVATE_KEY"
}
}
}
}You can run an Aptos MCP server that exposes account, token, and transaction operations to your AI applications. This server lets you create Aptos accounts, fund testnet accounts, manage native APT and custom coins, and query transactions, all through a configurable local process or a remote endpoint.
How to use
Use an MCP client to connect to the Aptos MCP server and access a suite of tools for Aptos accounts, tokens, and transactions. You can create accounts, fund testnet accounts, query balances, transfer APT, deploy and mint custom coins, and check transaction status. Configure your client to point at the MCP server you run locally or remotely, then call the available tools by name with the required arguments.
How to install
Prerequisites you need before installing:
- Node.js v18 or higher
- An Aptos private key for signing transactions
- Access to Aptos testnet by default (or mainnet if you choose) "
# Step 1: Clone the project
git clone <your-repo-url>
cd aptos_mcp
# Step 2: Install dependencies
npm install
# Step 3: Build the project
npm run build
# Step 4: Start the server (example)
# You can run it directly or via your MCP client configuration
node build/index.js
Additional sections
Configuration, security, and usage tips are provided below to help you run and integrate the Aptos MCP server smoothly.
User-facing configuration for the MCP client is shown in the example below. This example config demonstrates how to connect to the local Aptos MCP server using a standard Node.js runtime. Replace the placeholder paths and keys with your actual values.
{
"mcpServers": {
"aptos_mcp": {
"command": "node",
"args": [
"/path/to/aptos_mcp/build/index.js"
],
"env": {
"APTOS_MCP_PRIVATE_KEY": "0x1234567890abcdef...",
"APTOS_MCP_NETWORK": "testnet"
}
}
}
}
Security and environment
Expose only the necessary environment variables to your runtime. Never commit private keys to version control. Use secure key management for production deployments.
Optional environment controls let you override the default Aptos node and faucet endpoints. If you provide custom URLs, ensure they are reachable by the MCP server and configured to match your chosen network (testnet or mainnet).
Available tools
create_account
Create a new Aptos account with a random private key and return the account address, private key, and public key.
get_account_info
Fetch detailed information about an Aptos account, including sequence number and authentication key.
fund_account
Fund an Aptos account on the testnet faucet to enable testing with APT tokens.
get_apt_balance
Retrieve the native APT balance for a given account.
transfer_apt
Transfer native APT tokens from one account to another.
get_coin_balance
Get the balance of a specific custom coin type for an account.
transfer_coin
Transfer a specific custom coin type to another account.
deploy_coin
Deploy a new custom coin on the Aptos blockchain.
mint_coin
Mint new tokens for a previously deployed custom coin to a recipient.
register_coin
Register an account to receive a specific custom coin type.
get_transaction_status
Query the status and details of a transaction by its hash.
get_account_transactions
Fetch recent transactions for a specific Aptos account.