🚀 Aptos MCP 服务器

Aptos MCP 服务器是一个用于交互 Aptos 文档并创建全栈 Aptos 区块链应用程序的模型上下文协议（MCP）服务器，能够帮助开发者更高效地进行 Aptos 项目的开发与测试。

🚀 快速开始

Aptos MCP 服务器可助力开发者与 Aptos 文档交互并创建全栈区块链应用程序。按以下步骤操作，即可快速开启使用之旅。

✨ 主要特性

• 🔍 浏览和搜索 Aptos 文档，方便开发者快速获取所需信息。
• 🔧 创建新的 Aptos 项目（全栈、合约或客户端），满足不同开发场景需求。
• 🧩 生成 Aptos 项目的组件，提高开发效率。
• 🧪 测试 Aptos Move 合约，确保合约的正确性和稳定性。
• 📜 为 Move 合约生成 TypeScript ABI 接口，便于与其他系统集成。

📦 安装指南

先决条件

• Python 3.10 或更高版本
• Node.js 和 npm
• Aptos CLI（用于某些工具功能）

设置

1. 安装 mcp 包：

uv add "mcp[cli]"
# 或者 
pip install "mcp[cli]"

2. 克隆此仓库：

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

3. 安装依赖项：

uv add httpx
# 或者
pip install httpx

4. （可选）设置 GitHub 令牌以提高 API 速率限制：

export GITHUB_TOKEN=your_github_token

💻 使用示例

与 Claude Desktop 一起使用

基础用法

1. 从 claude.ai/download 下载并安装 Claude Desktop。
2. 将 Aptos MCP 服务器添加到你的 Claude Desktop 配置中：

mcp install aptos_mcp_server.py

或手动编辑 ~/Library/Application Support/Claude/claude_desktop_config.json（macOS）或 %APPDATA%\Claude\claude_desktop_config.json（Windows）：

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

3. 重启 Claude Desktop

高级用法

以开发模式运行服务器，并使用 MCP Inspector：

mcp dev aptos_mcp_server.py

连接到 Claude Desktop 后的操作

基础用法

一旦连接到 Claude Desktop，你可以进行以下操作：

• 浏览 Aptos 文档：让 Claude 展示 Aptos 文档库的结构，例如：
  • "显示 Aptos 文档结构"
  • "查找有关 Move 模块的信息"
  • "获取 Table 实现文档"
• 创建新项目：让 Claude 设置新的 Aptos 项目，例如：
  • "创建名为'my-first-dapp'的新 Aptos 全栈项目"
  • "为市场生成一个 Move 智能合约"
  • "设置一个仅客户端的 Aptos 项目"
• 生成组件：让 Claude 为你当前的 Aptos 项目生成组件，例如：
  • "生成用于连接到 Aptos 钱包的 React 组件"
  • "创建存储用户配置文件的 Move 表格"
  • "为查询合同数据创建客户端函数"
• 测试和生成 ABI：让 Claude 测试合约并生成接口，例如：
  • "测试我在~/projects/my-dapp/move 处的 Aptos 合约"
  • "为我的 Move 合约生成 TypeScript 绑定"

高级用法

以下是一些示例查询，展示了更多高级的使用场景：

• "浏览 Aptos 文档"
• "在 Aptos 文档中搜索'table'"
• "创建名为'nft-marketplace'的新 Aptos 全栈项目"
• "生成一个用于代币合约的 Move 模块"
• "创建用于钱包连接的 React 组件"
• "为我的合同生成 TypeScript ABI"
• "测试我合同中的撤回功能"

📄 许可证

本项目采用 MIT 许可证。