使用说明
项目简介
scaffold-agent 仓库旨在展示如何使用 Console Kit 构建自主的 DeFi 代理。其中 'ft-mcpserver' 分支提供了一个 MCP 服务器的示例实现,用于将 Console Kit 的 DeFi 功能以标准化的 MCP 协议暴露给 LLM 客户端,方便 LLM 应用集成和调用 DeFi 相关的上下文信息和操作能力。
主要功能点
- 资源管理: 虽然仓库没有明确展示资源管理的具体代码,但作为 MCP 服务器,它预期能够管理和提供 DeFi 相关的链上数据、账户信息等资源,供 LLM 客户端查询和使用。
- 工具注册与执行: 该示例集成了 Console Kit 的核心功能,Console Kit 提供了丰富的 DeFi 操作工具(如交易、转账等)。MCP 服务器可以注册这些工具,并允许 LLM 客户端通过 MCP 协议调用执行 DeFi 操作。
- Prompt 模板: 仓库中没有直接展示 Prompt 模板功能,但 MCP 服务器通常会支持 Prompt 模板,以便根据不同的用户需求和场景,定制与 LLM 的交互方式。该示例可能需要用户自行扩展 Prompt 模板功能。
- JSON-RPC 协议: 作为 MCP 服务器,它使用 JSON-RPC 协议与客户端通信,接收和处理来自 LLM 客户端的请求。
- DeFi 工作流自动化: 基于 Console Kit 强大的 DeFi 功能,该 MCP 服务器可以支持构建复杂的 DeFi 自动化工作流,例如自动化的交易策略、资产管理等。
安装步骤
-
克隆仓库并切换到 'ft-mcpserver' 分支:
git clone https://github.com/Brahma-fi/scaffold-agent.git cd scaffold-agent git checkout ft-mcpserver -
安装依赖:
yarn install -
配置环境变量:
- 复制 '.env.example' 文件为 '.env':
cp .env.example .env - 修改 '.env' 文件,根据您的实际情况填写以下环境变量:
- 'EXECUTOR_EOA_PRIVATE_KEY': 执行器 EOA 的私钥。
- 'JSON_RPC_URL': 区块链 JSON RPC URL。
- 'CONSOLE_API_KEY': Console Kit API 密钥。
- 'CONSOLE_BASE_URL': Console Kit Base URL。
- 'EXECUTOR_CLIENT_ID': 执行器客户端 ID。
- 'EXECUTOR_REGISTRY_ID': 执行器 Registry ID (可能需要在 Console Kit 平台注册执行器后获取)。
- 'USER_EOA_PRIVATE_KEY': 用户 EOA 的私钥 (用于部署和管理自动化账户)。
- 'SUBACCOUNT_ADDRESS': 自动化子账户地址 (如果需要更新或取消自动化,需要填写)。
- 'CONSOLE_ADDRESS': Owner Console 地址 (Safe 地址,如果需要更新或取消自动化,需要填写)。
- 复制 '.env.example' 文件为 '.env':
-
运行 MCP 服务器:
- 查看 'ft-mcpserver' 分支下的 'README.md' 或相关文档,查找启动 MCP 服务器的具体命令。
- 通常可能使用 'node server.js' 或类似的命令来启动服务器 (请根据实际代码调整)。
服务器配置
以下是一个 MCP 客户端连接到该 MCP 服务器的配置示例 (JSON 格式):
{ "serverName": "scaffold-agent-mcpserver", "command": "node", "args": [ "path/to/your/scaffold-agent/ft-mcpserver/server.js" ], "description": "Scaffold Agent MCP Server for DeFi automation", "protocol": "json-rpc", "transport": "stdio" }
配置参数说明:
- 'serverName': MCP 服务器的名称,可以自定义。
- 'command': 启动 MCP 服务器的命令,通常是 'node' (假设服务器是 Node.js 应用)。
- 'args': 启动命令的参数,这里指向 MCP 服务器的入口文件 'server.js' 的路径。请根据您的实际文件路径进行调整。
- 'description': 服务器的简短描述。
- 'protocol': 通信协议,通常为 'json-rpc'。
- 'transport': 传输协议,'stdio' 表示标准输入输出,也可能支持 'websocket' 或 'sse',请根据服务器实际实现选择。
注意:
- 上述 'args' 中的文件路径 'path/to/your/scaffold-agent/ft-mcpserver/server.js' 只是示例,您需要将其替换为 scaffold-agent 仓库 'ft-mcpserver' 分支中实际的服务器入口文件路径。 请仔细检查 'ft-mcpserver' 分支的代码和文档,确认服务器的启动方式和入口文件。
- 该配置假设 MCP 服务器使用 'stdio' 传输协议。如果服务器支持其他传输协议 (如 WebSocket),您需要相应地修改 'transport' 字段,并根据 MCP 客户端的要求配置连接地址等信息。
- 启动 MCP 服务器前,请确保已正确配置 '.env' 文件中的环境变量。
基本使用方法
- 启动 MCP 服务器: 按照 'ft-mcpserver' 分支的说明启动 MCP 服务器。
- 配置 MCP 客户端: 在您的 LLM 应用或 MCP 客户端中,配置上述服务器配置信息,连接到 scaffold-agent MCP 服务器。
- 使用 MCP 客户端与服务器交互: 通过 MCP 客户端,您可以向 scaffold-agent MCP 服务器发送 MCP 请求,例如:
- 查询 DeFi 资源信息 (例如链上代币价格、账户余额等)。
- 调用 DeFi 工具执行操作 (例如发起交易、转账等)。
- 使用 Prompt 模板与 LLM 进行交互,实现基于 DeFi 上下文的智能对话或决策。
详细的使用方法和 API 文档需要参考 'ft-mcpserver' 分支的具体代码和文档。 该仓库主要提供示例代码,可能需要您根据实际需求进行二次开发和扩展。
信息
分类
开发者工具