README
🚀 Hedera MCP 服务器
该项目提供了一个与 Langchain 包装器集成的服务器,用于与 Hedera 网络交互。借助此服务器,用户能够通过自然语言命令执行 Hedera 操作,这些操作由 Langchain 设置实现。
🚀 快速开始
整个项目包含两个需要运行的服务,以下是具体的启动步骤:
1. 克隆仓库
git clone https://github.com/mateuszm-arianelabs/hedera-mcp-server.git
cd hedera-mcp-server
2. 设置环境变量
需要复制 .env.example 文件,并在以下两个位置创建 .env 文件:
packages/langchain-proxypackages/mcp-server
编辑 .env 文件并填写所需的配置值(例如 Hedera 密钥、网络详细信息)。
API_URL= # langchain 代理端点 URL
PORT= # MCP 服务器运行的端口
MCP_AUTH_TOKEN= # 用逗号分隔的接受令牌数组
LANGCHAIN_PROXY_TOKEN= # 访问 Langchain 代理的令牌
3. 安装依赖项
pnpm install
4. 启动 Langchain 代理服务
pnpm run dev:lc
(或使用 pnpm start 进入生产模式,前提是已完成相应配置)。
5. 运行 mcp 服务器
pnpm run dev:mcp
(或使用 pnpm start 进入生产模式,前提是已完成相应配置)。
✨ 主要特性
与 Hedera 交互
这是核心功能,允许服务器通过正在运行的 Langchain 包装器服务进行调用。包装器会解释这些请求,并在 Hedera 网络上执行相应的操作,例如创建代币、转移 HBAR、与智能合约交互等。
📦 安装指南
先决条件
在开始之前,请确保安装了以下内容:
- Node.js(推荐版本 20 或更高)
- pnpm (
npm install -g pnpm) - Git
💻 使用示例
Visual Studio Code 的配置
为了与 MCP 服务器建立连接,需要 X-MCP-AUTH-TOKEN 头。以下是用于 Visual Studio Code 的示例 .vscode/settings.json 配置:
{
"mcp": {
"inputs": [],
"servers": {
"hedera": {
"type": "sse",
"url": "http://localhost:3000/sse",
"headers": { "X-MCP-AUTH-TOKEN": "your-mcp-auth-token"}
}
}
}
}
⚠️ 重要提示
目前,传递自定义头(例如
X-MCP-AUTH-TOKEN)在 Cursor IDE 中不受支持。来源
🔧 技术细节
整体架构图
以下是系统组件的简要描述:
- MCP 服务器:负责处理来自客户端的请求,并通过 Langchain 包装器与 Hedera 网络交互。
- Langchain 包装器:作为中介,将自然语言指令转换为 Hedera 网络可以理解的操作。
- Hedera 网络:执行实际操作并返回结果。
潜在过渡到 OAuth
- Hedera 代币服务:探索 Hedera 的代币服务,并结合其与智能合约的集成,实现更复杂的去中心化应用。
- Solidus 协议:了解如何在 Hedera 网络上使用 Solidus 实现安全且可扩展的支付解决方案。
📚 详细文档
API 文档
请求结构
所有请求都需要包含以下内容:
Content-Type: application/json
响应结构
响应将采用 JSON 格式,如下所示:
{
"code": 200,
"message": "操作成功"
}
示例错误响应
当未提供有效令牌时,返回以下内容:
{
"error": {
"code": 401,
"message": "未经授权:缺少有效的 X-MCP-AUTH-TOKEN 头"
}
}
端点示例
获取状态
curl --location 'http://localhost:3000/status' \
--header 'X-MCP-AUTH-TOKEN: your-token'
响应:
{
"status": "ok",
"timestamp": "2024-01-01T00:00:00.000Z"
}
执行操作
curl --location 'http://localhost:3000/execute' \
--header 'X-MCP-AUTH-TOKEN: your-token' \
--data-raw '{"operation": "创建代币"}'
响应:
{
"result": {
"tokenAddress": "0.0.123456789"
}
}
📄 结论
通过遵循上述步骤和文档,您可以轻松设置和使用 Hedera MCP 服务器,并与 Hedera 网络进行交互。
Scan to join WeChat group