README
🚀 mcp-server-skyfire
这是一个实现模型上下文协议(MCP)的服务器,主要用于和Skyfire支付系统进行交互。借助该服务器,AI模型能够利用Skyfire的基础设施完成付款操作,并且采用标准化协议,极大提升了支付的规范性和便捷性。
🚀 快速开始
该服务器实现了模型上下文协议,以便通过Skyfire的API提供支付功能。它暴露了一个工具make_payment,允许授权客户端向Skyfire用户发起付款请求。
📦 安装指南
克隆仓库
git clone <repository-url>
cd mcp-server-skyfire
安装依赖项
npm install
配置API密钥
在根目录中创建一个.env文件,并添加您的Skyfire API密钥:
SKYFIRE_API_KEY=your_api_key_here
构建项目
npm run build
这将完成以下操作:
- 将TypeScript编译为JavaScript
- 使输出文件可执行
- 将构建文件放在
./build目录中
💻 使用示例
基础用法
使用make_payment工具向指定的Skyfire用户发送付款:
{
"content": [
{
"type": "text",
"text": "[金额]已成功发送到[用户名]"
}
]
}
✨ 主要特性
工具暴露
该服务器通过MCP接口暴露了make_payment工具,可向指定的Skyfire用户发送付款。
错误处理
该服务器实现了全面的错误处理,以应对各种情况:
- 无效工具名称:返回
MethodNotFound错误 - 缺少或无效参数:返回
InvalidParams错误 - 支付处理失败:返回
InternalError错误
🔧 技术细节
开发设置
该项目使用TypeScript设置,并包含:
- 严格的类型检查
- ES2022目标
- Node16模块解析
- 文件大小写一致性的强制执行
运行方式
该服务器基于标准输入/输出(stdio)运行。构建后,您可以使用以下命令运行:
./build/index.js
或通过npm脚本:
mcp-server-skyfire
📚 详细文档
make_payment工具
向指定的Skyfire用户发送付款。
参数:
receiverUsername(字符串):收款人用户名amount(字符串):付款金额
依赖项
主要依赖包括:
@modelcontextprotocol/sdk: ^1.0.3@skyfire-xyz/skyfire-sdk: ^0.8.5dotenv: ^16.4.7zod: ^3.24.1
Scan to join WeChat group