Armor Crypto MCP Server 使用说明

项目简介

Armor Crypto MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在为 LLM Agent 提供访问加密货币世界的能力。它通过封装 Armor API，将区块链数据查询、代币兑换、交易执行等功能以 MCP 标准化的方式暴露出来，使得 LLM Agent 可以方便安全地与加密货币应用进行交互。

主要功能点

资源访问 (Resources): 提供对钱包信息的读取能力，例如获取所有钱包列表及其余额 ('wallets://all')。
工具调用 (Tools):
- 获取钱包和代币信息，如查询钱包代币余额、获取代币详情、列出钱包组等。
- 执行交易操作，如代币兑换、发起交易、创建和取消 DCA (Dollar-Cost Averaging) 定投订单等。
- 管理钱包和钱包组，如创建、归档、取消归档钱包和钱包组，以及向钱包组添加或移除钱包。
Prompt 模板 (Prompts): 包含简单的 Prompt 模板，例如用户登录提示 ('login_prompt')。

安装步骤

克隆仓库:

git clone https://github.com/armorwallet/armor-crypto-mcp
cd armor-crypto-mcp

安装依赖: 确保你的Python环境中安装了必要的库，可以通过以下命令安装：

pip install python-dotenv httpx mcp  # mcp可能需要手动安装，如果pip无法直接安装，请参考fastmcp文档

注意: 仓库中使用了 'fastmcp' 框架，但 'pip install mcp' 可能安装的是其他库。请根据实际情况调整安装命令，或者手动安装 'fastmcp' (如果仓库文档或 'build.py' 中有更具体的依赖信息，请优先参考)。

配置环境变量:
- 创建 '.env' 文件在仓库根目录下 (如果尚不存在)。
- 在 '.env' 文件中设置 'ARMOR_ACCESS_TOKEN' 环境变量，你需要从 Armor 平台获取有效的 Access Token。
- （可选）可以设置 'BASE_API_URL' 环境变量来指定 Armor API 的基础 URL，默认为 'https://armorai.dev'。

服务器配置 (servers_config.json)

要使 MCP 客户端（如 Claude Desktop, Cline 等）能够连接到 Armor Crypto MCP Server，需要在客户端的配置文件 'servers_config.json' 中添加如下服务器配置信息。以下是一个示例配置，你需要根据实际情况进行调整：

[
  {
    "server_name": "Armor Crypto MCP",  // MCP 服务器的名称，客户端界面会显示
    "command": "python",             // 启动服务器的命令，这里假设使用 python 解释器
    "args": [                        // 启动命令的参数列表
      "armor_mcp.py"               // 指定要运行的 MCP 服务器脚本
    ],
    "transport": "stdio",            // 使用 stdio 作为传输协议 (根据 fastmcp 默认配置)
    "description": "Armor Crypto MCP Server for accessing blockchain and crypto functionalities." // 服务器的描述信息
  }
]

参数注释:

'server_name': 服务器的名称，自定义，用于在 MCP 客户端中标识该服务器。
'command': 运行服务器的命令，通常是 Python 解释器 'python' 或 'python3'。
'args': 传递给 'command' 的参数列表，这里指定了运行 'armor_mcp.py' 脚本。
'transport': MCP 客户端与服务器通信的传输协议，'stdio' 表示标准输入输出。'fastmcp' 默认支持 'stdio'。
'description': 服务器的描述，可选，用于提供更多关于服务器的信息。

注意:

确保你的 Python 环境可以正确执行 'python armor_mcp.py' 命令。
MCP 客户端可能需要将 'servers_config.json' 文件放置在特定的目录下，请参考你的 MCP 客户端的文档。

基本使用方法

启动 MCP 服务器: 在仓库根目录下，打开终端并执行以下命令启动 Armor Crypto MCP Server：
```
python armor_mcp.py
```
服务器成功启动后，你可能会看到日志信息输出到 'armor_api_server.log' 文件中。
配置并连接 MCP 客户端:
- 将上面提供的 'servers_config.json' 配置信息添加到你的 MCP 客户端的配置文件中。
- 启动 MCP 客户端。客户端应该能够检测到并连接到 Armor Crypto MCP Server。
在 LLM Agent 中使用:
- 在你的 LLM Agent 中，你可以通过 MCP 协议调用 Armor Crypto MCP Server 提供的资源和工具。
- 例如，你可以指示 Agent 使用 'get_wallet_token_balance' 工具查询特定钱包的代币余额，或者使用 'swap_quote' 工具获取代币兑换报价。
- 具体如何调用取决于你的 LLM Agent 的 MCP 客户端实现和 Agent 的指令设计。

重要提示:

本项目依赖于 Armor API 和有效的 Armor Access Token。请确保你拥有有效的 Access Token 并正确配置环境变量。
代码仓库目前标记为 "not very organized"，可能处于开发初期，使用时请注意潜在的 bug 和不稳定性。
详细的 API 功能和参数信息请参考 'armor_client.py' 中的类型定义和函数注释，以及 'armor_mcp.py' 中工具和资源的描述。

Armor Crypto MCP Server