Aptos MCP Server

🚀 套用 MCP 服务器

这是一个用于交互套用（Aptos）documentation 和创建全栈套用区块链应用程序的模型上下文协议（MCP）服务器，能有效助力区块链应用的开发与管理。

🚀 快速开始

本服务器可让你与套用（Aptos）documentation 进行交互，还能创建全栈套用区块链应用程序。连接到 Claude Desktop 后，你就能轻松执行各类操作。

✨ 主要特性

• 🔍 可浏览和搜索套用 documentation。
• 🔧 能够创建新的套用项目，涵盖全栈、合同或客户等类型。
• 🧩 可以生成套用项目的组件。
• 🧪 支持测试套用 Move 合同。
• 📜 能为 Move 合同生成 TypeScript ABI 接口。

📦 安装指南

前置条件

• Python 3.10 或更高版本。
• Node.js 和 npm。
• 套用 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. 将套用 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 检查器：

mcp dev aptos_mcp_server.py

具体操作示例

基础用法

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

# 浏览套用 Documentation
让 Claude 浏览套用 documentation 仓库的结构：
- "展示套用文档的结构"
- "查找关于 Move 模块的信息"
- "获取 Table 实现文档"

# 创建新项目
让 Claude 帮助你设置新的套用项目：
- "创建一个名为 'my-first-dapp' 的套用全栈项目"
- "生成一个 marketplace 的 Move 智能合同"
- "设置一个仅限客户的套用项目"

# 生成组件
让 Claude 为你的套用项目生成组件：
- "生成 React 组件用于连接到套用钱包"
- "创建一个存储用户配置文件的 Move 表"
- "制作一个查询合同数据的客户函数"

# 测试和生成 ABIs
让 Claude 测试合同并生成接口：
- "测试我的位于 ~/projects/my-dapp/move 的套用合同"
- "为我的 Move 合同生成 TypeScript 绑定"

高级用法

以下是一些示例查询，可帮助你更好地使用该服务器：

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

📄 许可证

本项目采用 MIT 许可证。