MoveFlow Aptos MCP Server

by ctianming

157 downloads Not rated yet MIT
GitHub

About

# MoveFlow Aptos MCP Server A Model Context Protocol (MCP) server that enables AI assistants to interact with the MoveFlow protocol on Aptos blockchain. This server provides a standardized interface for AI tools to create, manage, and interact with cryptocurrency streaming payments. ## Features - **Stream Management**…

Details

License
MIT

Explore

- Stream Management
- Create payment streams (regular or one-time payments)
- Withdraw funds from active streams
- Close existing streams
- Extend stream durations
- Pause and resume streams
- Query stream information

- Batch Operations
- Create multiple streams at once
- Withdraw from multiple streams simultaneously

- MCP Integration
- Full Model Context Protocol (MCP) compatibility
- Automatic tool discovery through MCP capability interface
- Standardized input schema validation
- Self-documenting API

- Security
- Client-side signing support for secure transaction handling
- Read-only mode for safe data queries
- Direct signing mode for development and testing

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name MoveFlow Aptos MCP Server
    Command (node, npx, python, etc.)

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

1. Clone the repository:

   git clone https://github.com/moveflow/moveflow-aptos-mcp-server.git
cd moveflow_aptos_mcp_server

2. Install dependencies:

   npm install

3. Build the project:

   npm run build

4. Start the server:

   APTOS_NODE_URL="https://fullnode.mainnet.aptoslabs.com/v1" \
APTOS_NETWORK="mainnet" \
READ_ONLY_MODE="true" \
node build/index.js

5. Verify the server is running:
You should see the following output:

   Starting MoveFlow Aptos MCP Server...
Initialized Stream with read-only mode
MoveFlow Aptos MCP Server tools registered
MoveFlow Aptos MCP Server started

You can also install and use the server as an NPM package:

npm install @moveflow/aptos-mcp-server

npx @moveflow/aptos-mcp-server --env.APTOS_NETWORK=testnet --env.READ_ONLY_MODE=true


For Claude Desktop integration with NPX:
json
{
"mcpServers": {
"moveflow-aptos": {
"command": "npx",
"args": ["-y", "@moveflow/aptos-mcp-server"],
"env": {
"APTOS_NODE_URL": "https://fullnode.mainnet.aptoslabs.com/v1",
"APTOS_NETWORK": "mainnet",
"READ_ONLY_MODE": "true"
}
}
}
}
``

| Variable | Description | Required | Default |
| ------------------- | ----------------------------------------------------- | -------- | ----------------------------------------- |
|
APTOS_NODE_URL | Aptos node URL | Yes | https://fullnode.mainnet.aptoslabs.com/v1 |
|
APTOS_NETWORK | Network type: "mainnet", "testnet", "devnet", "local" | Yes | "mainnet" |
|
READ_ONLY_MODE | Set to "true" to enable read-only mode | No | "false" |
|
SIGNING_MODE | Signing mode: "direct" or "client" | No | "client" |
|
APTOS_PRIVATE_KEY | Private key for direct signing mode | No | - |
|
APTOS_FAUCET_URL | Test/Dev network faucet URL | No | - |

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

npm install

create-stream

Create a new MoveFlow stream

withdraw-stream

Withdraw funds from a stream

close-stream

Close a MoveFlow stream

extend-stream

Extend a stream's duration

get-stream-info

Get stream information

batch-create-streams

Create multiple streams

batch-withdraw-streams

Withdraw from multiple streams

pause-stream

Pause a stream

resume-stream

Resume a paused stream

The MoveFlow Aptos MCP server provides the following tools:

| Tool Name | Description | Function |
| ------------------------ | ------------------------------ | --------------------------------------------------------------- |
| create-stream | Create a new MoveFlow stream | Creates a new cryptocurrency stream to transfer funds over time |
| withdraw-stream | Withdraw funds from a stream | Withdraws available funds from an active stream |
| close-stream | Close a MoveFlow stream | Terminates a stream and returns remaining funds to sender |
| extend-stream | Extend a stream's duration | Increases the end time of an existing stream |
| get-stream-info | Get stream information | Retrieves details about a specific stream |
| batch-create-streams | Create multiple streams | Creates multiple streams in a single transaction |
| batch-withdraw-streams | Withdraw from multiple streams | Withdraws from multiple streams in a single transaction |
| pause-stream | Pause a stream | Temporarily stops a stream's payments |
| resume-stream | Resume a paused stream | Restarts a paused stream |

The server includes a test script to verify all MCP tools are working correctly:

```bash

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "moveflow aptos mcp server": {
            "moveflow_aptos_mcp_server": {
                "command": "node",
                "args": [
                    "build/index.js"
                ]
            }
        }
    }
}

McpServers

{
    "moveflow_aptos_mcp_server": {
        "command": "node",
        "args": [
            "build/index.js"
        ]
    }
}

A Model Context Protocol (MCP) server that enables AI assistants to interact with the MoveFlow protocol on Aptos blockchain. This server provides a standardized interface for AI tools to create, manage, and interact with cryptocurrency streaming payments.

Features

- Stream Management
- Create payment streams (regular or one-time payments)
- Withdraw funds from active streams
- Close existing streams
- Extend stream durations
- Pause and resume streams
- Query stream information

- Batch Operations
- Create multiple streams at once
- Withdraw from multiple streams simultaneously

- MCP Integration
- Full Model Context Protocol (MCP) compatibility
- Automatic tool discovery through MCP capability interface
- Standardized input schema validation
- Self-documenting API

- Security
- Client-side signing support for secure transaction handling
- Read-only mode for safe data queries
- Direct signing mode for development and testing

Available MCP Tools

The MoveFlow Aptos MCP server provides the following tools:

| Tool Name | Description | Function |
| ------------------------ | ------------------------------ | --------------------------------------------------------------- |
| create-stream | Create a new MoveFlow stream | Creates a new cryptocurrency stream to transfer funds over time |
| withdraw-stream | Withdraw funds from a stream | Withdraws available funds from an active stream |
| close-stream | Close a MoveFlow stream | Terminates a stream and returns remaining funds to sender |
| extend-stream | Extend a stream's duration | Increases the end time of an existing stream |
| get-stream-info | Get stream information | Retrieves details about a specific stream |
| batch-create-streams | Create multiple streams | Creates multiple streams in a single transaction |
| batch-withdraw-streams | Withdraw from multiple streams | Withdraws from multiple streams in a single transaction |
| pause-stream | Pause a stream | Temporarily stops a stream's payments |
| resume-stream | Resume a paused stream | Restarts a paused stream |

Available Resources

The MoveFlow Aptos MCP server also provides access to blockchain resources:

| Resource URI | Description |
| ------------------------------- | ------------------------------------------------------ |
| moveflow://streams/active | Lists all active streams for the current account |
| moveflow://streams/{streamId} | Retrieves detailed information about a specific stream |

These resources can be accessed directly by AI assistants supporting the MCP protocol, providing contextual information without requiring explicit tool calls.

Installation and Setup

1. Clone the repository:

   git clone https://github.com/moveflow/moveflow-aptos-mcp-server.git
cd moveflow_aptos_mcp_server

2. Install dependencies:

   npm install

3. Build the project:

   npm run build

4. Start the server:

   APTOS_NODE_URL="https://fullnode.mainnet.aptoslabs.com/v1" \
APTOS_NETWORK="mainnet" \
READ_ONLY_MODE="true" \
node build/index.js

5. Verify the server is running:
You should see the following output:

   Starting MoveFlow Aptos MCP Server...
Initialized Stream with read-only mode
MoveFlow Aptos MCP Server tools registered
MoveFlow Aptos MCP Server started

Installation via NPM Package

You can also install and use the server as an NPM package:

npm install @moveflow/aptos-mcp-server

AI Assistant Integration

Claude Desktop Integration

Add this server to your Claude Desktop configuration:

1. Open the Claude Desktop configuration file:
- macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
- Windows: %APPDATA%\Claude\claude_desktop_config.json

2. Add the following configuration (adjust the path according to your setup):

{
"mcpServers": {
"moveflow-aptos": {
"command": "node",
"args": ["/path/to/moveflow_aptos_mcp_server/build/index.js"],
"env": {
"APTOS_NODE_URL": "https://fullnode.mainnet.aptoslabs.com/v1",
"APTOS_NETWORK": "mainnet",
"READ_ONLY_MODE": "true" // Set to "true" for read-only mode, omit for transaction preparation mode
},
"disabled": false,
"autoApprove": []
}
}
}

Using with NPX

You can run this server directly using npx without installing it globally:

```bash

No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.