article
README
🚀 Enjin平台API工具MCP服务器
Enjin平台API工具MCP服务器允许与Enjin平台API进行交互,为开发者提供便捷的API调用途径,助力开发工作高效开展。
🚀 快速开始
🔍 先决条件
- Node.js(v16或更高版本)
- 任何受支持的MCP IDE
- Enjin平台API密钥
⚙️ 设置说明
1. 获取Enjin平台API密钥
- 在Enjin平台上创建一个账户。
- 生成API密钥。
2. 初始项目设置
安装依赖项:
npm install
3. 配置环境变量
创建用于本地开发的.env文件(不要提交此文件),或在IDE的MCP服务器配置中定义环境变量。
示例:
ENJIN_API_ENDPOINT=https://platform.canary.enjin.io/graphql
ENJIN_API_KEY=your-enjin-api-key
4. 配置你的受支持IDE
按照你特定IDE的说明配置MCP服务器。这通常涉及以下步骤:
- 添加新的服务器配置。
- 指定运行服务器的命令(例如,
node build/index.js)。 - 设置环境变量(例如,
ENJIN_API_KEY)。 参阅你的IDE文档以获取详细说明。
✨ 主要特性
🛠️ 可用工具
当前服务器提供以下工具:
create_collection
在Enjin平台上创建一个新的NFT集合。需要以下参数:
name: (字符串) 集合的名称。description: (字符串) 集合的描述。media: (字符串) 集合媒体URL。
get_collection
从Enjin平台获取一个集合。需要以下参数:
collection_id: (字符串) 集合ID。
📄 类型定义
// 示例类型定义 - 根据你的API响应进行调整
interface EnjinApiError {
status?: number;
message: string;
code?: string;
}
interface Collection {
id: string;
name: string;
description: string;
media: string;
// ... 其他集合属性
}
❌ 错误处理
服务器处理各种错误场景:
环境错误
- 缺少
ENJIN_API_KEY - 无效的API密钥
API错误
- 速率限制
- 无效请求参数
- 内部服务器错误
🛠️ 常见问题解决
工具在IDE中未显示
- 检查IDE日志
- 验证
ENJIN_API_KEY是否正确设置 - 确保服务器正在运行
认证错误
- 验证API密钥是否有效
- 检查密钥是否有必要的权限
查看日志
要查看服务器日志,请参阅IDE文档以了解如何查看MCP服务器的日志。
环境变量
如果你遇到环境变量错误,请验证以下内容:
ENJIN_API_ENDPOINT: 应该是有效的Enjin平台API端点ENJIN_API_KEY: 应该是有效的Enjin平台API密钥
⚠️ 安全注意事项
- 保持API密钥安全
- 不要将凭证提交到版本控制中
- 使用环境变量存储敏感数据
- 定期轮换API密钥
- 监控Enjin平台上API的使用情况
Scan to join WeChat group