关键词

Oraichain区块链LLM工具上下文服务

使用说明

项目简介

本项目是一个基于 Model Context Protocol (MCP) 的服务器实现，旨在为大型语言模型 (LLM) 应用提供与 Oraichain 区块链交互的能力。它允许 LLM 通过标准化的 MCP 协议调用预定义工具，执行如查询余额、转移代币、委托等区块链操作，从而扩展 LLM 在区块链领域的应用场景。

主要功能点

  • 工具注册与执行: 服务器可以注册和管理多种与 Oraichain 区块链相关的工具，例如查询账户余额、发起交易等。这些工具可以通过 'OraichainAgentKit' 与 Oraichain 网络进行交互。
  • 标准化 MCP 接口: 完全遵循 Model Context Protocol 协议，提供统一的 JSON-RPC 接口供 LLM 客户端调用，确保了良好的兼容性和互操作性。
  • 灵活的工具定义: 使用 Zod 库定义工具的参数和返回数据结构，保证了数据类型的严谨性和工具定义的灵活性。
  • 错误处理机制: 服务器具备完善的错误处理机制，能够以 MCP 标准格式向客户端返回错误信息，方便 LLM 应用进行错误处理和用户提示。

安装步骤

由于仓库是一个 Turborepo 项目，推荐使用 pnpm 进行安装和管理依赖。请确保已安装 Node.js 和 pnpm。

  1. 克隆仓库到本地：

    git clone https://github.com/oraichain/multichain-mcp.git
cd multichain-mcp

  2. 进入 'packages/mcp-server' 目录：

    cd packages/mcp-server

  3. 安装依赖：

    pnpm install

  4. 构建项目 (如果需要)：

    pnpm build

服务器配置

MCP 服务器需要配置启动命令和参数，以便 MCP 客户端能够连接和使用。以下是 MCP 客户端配置的 JSON 示例，你需要根据实际情况调整 'command' 和 'args' 字段：

{
  "serverName": "oraichain-mcp-server",
  "command": "node",
  "args": ["path/to/packages/mcp-server/dist/index.js"],  //  * 假设构建后的服务器入口文件为 index.js，请替换为实际路径
                                                            //  * 如果未构建，可以直接指向开发环境的入口文件，例如 ["ts-node", "index.ts"]
  "transport": "stdio",                                    //  *  选择 MCP 客户端和服务器都支持的传输协议，例如 stdio, websocket, sse 等
  "version": "0.1.0"                                     //  *  请根据实际情况填写服务器版本号，与 createMcpServer 函数中 options.version 一致
}

配置说明:

  • 'serverName': 服务器的名称，用于 MCP 客户端识别。请根据 'createMcpServer' 函数中 'options.name' 字段设置。
  • 'command': 启动服务器的命令。通常为 'node' 或 'ts-node' (如果使用 TypeScript 开发环境直接运行)。
  • 'args': 命令的参数，指向服务器的入口文件路径。如果是构建后的 JavaScript 文件，请指向构建目录下的 'index.js' (或其他入口文件)；如果是开发环境，可以使用 'ts-node index.ts' 指向 TypeScript 入口文件。
  • 'transport': MCP 客户端和服务器之间通信的传输协议。'stdio' 适用于本地进程间通信，'websocket' 或 'sse' 适用于网络通信。请确保客户端和服务器配置的传输协议一致。
  • 'version': 服务器的版本号，用于版本管理和兼容性判断。请根据 'createMcpServer' 函数中 'options.version' 字段设置。

请注意: 上述配置中的 'path/to/packages/mcp-server/dist/index.js' 和 'ts-node index.ts' 仅为示例，你需要根据实际的构建输出路径和开发环境配置进行调整。 请仔细检查并替换为正确的路径和命令参数。

基本使用方法

  1. 启动 MCP 服务器: 根据 MCP 客户端配置中的 'command' 和 'args' 在服务器端启动 MCP 服务器进程。
  2. 配置 MCP 客户端: 在 MCP 客户端中，根据上述 "服务器配置" 示例，配置连接到 Oraichain MCP 服务器所需的信息。
  3. 客户端调用工具: MCP 客户端通过 MCP 协议发送 JSON-RPC 请求到服务器，请求执行已注册的工具。请求参数需要符合工具定义的 Zod Schema。
  4. 服务器处理请求: Oraichain MCP 服务器接收到请求后，解析参数，调用相应的 'OraichainAgentKit' 功能与 Oraichain 区块链交互，并将结果封装成 MCP 响应返回给客户端。
  5. 客户端接收响应: MCP 客户端接收到服务器的响应，根据响应内容进行后续处理，例如展示结果给用户或继续进行其他操作。

更详细的使用方法和工具列表，请参考项目仓库中 'packages/mcp-server' 和 'packages/agent-kit' 目录下的代码和文档。

信息

分类

AI与计算

访问项目