Moveflow Aptos MCP Server

🚀 MoveFlow Server Documentation

MoveFlow Server is a server-side component designed to interact with the Aptos blockchain. It supports multiple operation modes and a secure architectural design. This document provides detailed information on its features, configuration, security, and development.

✨ Features

Core Features

• Blockchain Interaction: Communicates with the Aptos blockchain through adapters.
• MCP Tool Integration: Offers various Move Command Processor (MCP) tools, enabling a wide range of blockchain operations.
• Security Modes: Supports read-only mode, client signing mode, and direct signing mode.

Supported Operations

• Data Query: Retrieves transaction and account information from the blockchain.
• Transaction Preparation: Generates transaction objects without signing them.
• Transaction Signing and Submission: In direct signing mode, signs and submits transactions using the provided private key.

🚀 Quick Start

Install Dependencies

npm install moveflow-aptos-mcp-server

Start the Server

const { MoveFlowServer } = require('moveflow-aptos-mcp-server');

// Initialize configuration
const config = {
  aptosNodeUrl: 'https://fullnode.mainnet.aptoslabs.com',
  network: 'mainnet',
  readOnlyMode: true,
};

// Start the server
new MoveFlowServer(config).start();

Use Tools

const { tools } = require('moveflow-aptos-mcp-server');

// Query balance
tools.balance.queryBalance("0x1", (error, result) => {
  if (error) return console.error(error);
  console.log(result);
});

📚 Documentation

Environment Variables

*Required when SIGNING_MODE is set to "direct" and READ_ONLY_MODE is "false".

🔧 Technical Details

Client Signing Model

The server is designed to avoid storing private keys:

1. Read-Only Mode:
   • The recommended default operating mode.
   • Allows only querying blockchain data.
   • Does not support transaction execution.
   • Enable by setting READ_ONLY_MODE="true".
2. Transaction Preparation Mode:
   • When READ_ONLY_MODE is set to "false".
   • The server prepares transactions but does not sign them.
   • Transactions must be signed by the client application.
   • Provides enhanced security by separating transaction preparation from signing.
3. Direct Signing Mode (for Development):
   • When SIGNING_MODE is set to "direct" and APTOS_PRIVATE_KEY is provided.
   • The server signs and submits transactions using the provided private key.
   • Less secure but convenient for testing.
   • Not recommended for production environments.

Secure Transaction Architecture

The server architecture separates responsibilities:

• Server: Validates input and prepares transaction objects.
• Client: Manages private keys and signs transactions.
• API/Connector: Handles communication between the server and the client.

This design eliminates the need for the server to handle private keys, making it more secure in production environments.

💻 Usage Examples

Testing MCP Tools

The server includes a test script to verify the proper functioning of all MCP tools:

# Run the test script
npm run test-tools

This will execute a series of tests for each MCP tool to verify its correct functionality. You can also use different networks or signing modes by editing the configuration in test-tools.js.

📚 Development

Project Structure

The server codebase is organized as follows:

moveflow_aptos_mcp_server/
├── src/                    # Source code
│   ├── adapters/          # Blockchain adapters
│   ├── tools/             # MCP tool collection
│   └── server.js         # Server main file
├── package.json         # Dependency management
└── README.md            # Documentation

Development Steps

1. Clone the Repository:

   git clone [Repository URL]
   cd moveflow-aptos-mcp-server
   

2. Install Dependencies:

   npm install
   

3. Start the Development Server:

   npm start
   

Conclusion

MoveFlow Server provides powerful features and a flexible security architecture for interacting with the Aptos blockchain. With proper configuration and usage, you can easily integrate blockchain functionality into your applications.