Skip to main content

Add your description here

Project description

Aptos MCP Server

A Model Context Protocol (MCP) server for interacting with Aptos documentation and creating full-stack Aptos blockchain applications.

Features

  • 🔍 Browse and search Aptos documentation
  • 🔧 Create new Aptos projects (fullstack, contract, or client)
  • 🧩 Generate components for Aptos projects
  • 🧪 Test Aptos Move contracts
  • 📜 Generate TypeScript ABI interfaces for Move contracts

Installation

Prerequisites

  • Python 3.10 or later
  • Node.js and npm
  • Aptos CLI (for some tooling features)

Setup

  1. Install the mcp package:
uv add "mcp[cli]"
# or 
pip install "mcp[cli]"
  1. Clone this repository:
git clone https://github.com/yourusername/aptos-mcp-server.git
cd aptos-mcp-server
  1. Install dependencies:
uv add httpx
# or
pip install httpx
  1. (Optional) Set GitHub token for increased API rate limits:
export GITHUB_TOKEN=your_github_token

Using with Claude Desktop

  1. Install Claude Desktop from claude.ai/download

  2. Add the Aptos MCP Server to your Claude Desktop configuration:

mcp install aptos_mcp_server.py

Or manually edit ~/Library/Application Support/Claude/claude_desktop_config.json (macOS) or %APPDATA%\Claude\claude_desktop_config.json (Windows):

{
  "mcpServers": {
    "aptos-dev": {
      "command": "uv",
      "args": [
        "--directory",
        "/path/to/aptos-mcp-server",
        "run",
        "aptos_mcp_server.py"
      ]
    }
  }
}
  1. Restart Claude Desktop

Development

Run the server in development mode with the MCP Inspector:

mcp dev aptos_mcp_server.py

Usage

Once connected to Claude Desktop, you can:

Browse Aptos Documentation

Ask Claude to browse through the Aptos documentation repository:

  • "Show me the Aptos documentation structure"
  • "Find information about Move modules in the Aptos docs"
  • "Get me the Table implementation documentation"

Create New Projects

Ask Claude to set up new Aptos projects:

  • "Create a new Aptos full-stack project called 'my-first-dapp'"
  • "Generate a Move smart contract for a marketplace"
  • "Set up a client-only Aptos project"

Generate Components

Ask Claude to generate components for your Aptos projects:

  • "Generate a React component for connecting to Aptos wallet"
  • "Create a Move table for storing user profiles"
  • "Make a client function for querying contract data"

Test and Generate ABIs

Ask Claude to test contracts and generate interfaces:

  • "Test my Aptos contract at ~/projects/my-dapp/move"
  • "Generate TypeScript bindings for my Move contract"

Example Queries

  • "Browse through the Aptos documentation"
  • "Search the Aptos docs for 'table'"
  • "Create a new Aptos fullstack project called 'nft-marketplace'"
  • "Generate a Move module for a token contract"
  • "Create a React component for wallet connection"
  • "Generate TypeScript ABI for my contract"
  • "Test my contract's withdraw function"

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

iflow_mcp_aptos_mcp-0.1.0.tar.gz (15.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

iflow_mcp_aptos_mcp-0.1.0-py3-none-any.whl (14.6 kB view details)

Uploaded Python 3

File details

Details for the file iflow_mcp_aptos_mcp-0.1.0.tar.gz.

File metadata

  • Download URL: iflow_mcp_aptos_mcp-0.1.0.tar.gz
  • Upload date:
  • Size: 15.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.17

File hashes

Hashes for iflow_mcp_aptos_mcp-0.1.0.tar.gz
Algorithm Hash digest
SHA256 cd4cc37c554be6c77be9cb530ed03a2bbdb3a91e5fbfd86dcde66dade4cb8233
MD5 2a49467de81ca80c0384b05e9ec8762e
BLAKE2b-256 8b971c0bc778709bd08f97fb52f11380abdec71b2e8c99c798b1927d3af30b2c

See more details on using hashes here.

File details

Details for the file iflow_mcp_aptos_mcp-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for iflow_mcp_aptos_mcp-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a2dd0dabdb66abdea8e96ece282d949f3fe10d911c1ce6ac9b945df4cbe1ecf6
MD5 e6c6f0824740142a55f78e04f2f73e2b
BLAKE2b-256 d9c7b7eccc858f342939bcf2f38003f6acfcac5bfa79fcf1536bf6c1f8344861

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page