🚀 Uranium MCP Server
Uranium MCP Server 是一个用于与 portal.uranium.pro 协作的模型上下文协议(MCP)服务器,可用于创建和管理 NFT 集合与资产。该服务器使大语言模型(LLMs)能够通过简单、结构化的接口与区块链 NFT 进行交互。
🚀 快速开始
首先,使用您的客户端安装 Uranium MCP 服务器。
标准配置 适用于大多数工具:
{
"mcpServers": {
"uranium": {
"command": "npx",
"args": ["uranium-tools-mcp@latest"],
"env": {
"URANIUM_API_KEY": "your_api_key_here"
}
}
}
}
Claude Code
使用 Claude Code CLI 添加 Uranium MCP 服务器:
```bash
claude mcp add uranium npx uranium-tools-mcp@latest
```
然后在提示时设置您的 `URANIUM_API_KEY`。
Claude Desktop
添加到您的 Claude Desktop 配置文件中:
- macOS:`~/Library/Application Support/Claude/claude_desktop_config.json`
- Windows:`%APPDATA%\Claude\claude_desktop_config.json`
- Linux:`~/.config/Claude/claude_desktop_config.json`
{
"mcpServers": {
"uranium": {
"command": "npx",
"args": ["uranium-tools-mcp@latest"],
"env": {
"URANIUM_API_KEY": "your_api_key_here"
}
}
}
}
Codex
创建或编辑配置文件 `~/.codex/config.toml` 并添加:
```toml
[mcp_servers.uranium]
command = "npx"
args = ["uranium-tools-mcp@latest"]
env = { URANIUM_API_KEY = "your_api_key_here" }
```
更多信息,请参阅 [Codex MCP 文档](https://github.com/openai/codex/blob/main/codex-rs/config.md#mcp_servers)。
Cursor
#### 点击按钮安装:
[](cursor://anysphere.cursor-deeplink/mcp/install?name=uranium&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyJ1cmFuaXVtLXRvb2xzLW1jcEBsYXRlc3QiXSwiZW52Ijp7IlVSQU5JVU1fQVBJX0tFWSI6InlvdXJfYXBpX2tleV9oZXJlIn19)
或手动安装:
转到 Cursor 设置 -> MCP -> 添加新的 MCP 服务器。将其命名为 "uranium",使用 命令 类型并输入命令 npx uranium-tools-mcp@latest。添加环境变量 URANIUM_API_KEY 并输入您的 API 密钥。
Gemini CLI
遵循 MCP 安装 [指南](https://github.com/google-gemini/gemini-cli/blob/main/docs/tools/mcp-server.md#configure-the-mcp-server-in-settingsjson),使用上述标准配置并输入您的 API 密钥。
Goose
#### 点击按钮安装:
[](https://block.github.io/goose/extension?cmd=npx&arg=uranium-tools-mcp%40latest&id=uranium&name=Uranium&description=MCP%20for%20Uranium%20NFT%20tools%20to%20mint%2C%20list%2C%20and%20manage%20digital%20assets%20on%20the%20permaweb.)
或手动安装:
转到 高级设置 -> 扩展 -> 添加自定义扩展。将其命名为 "uranium",使用类型 STDIO,并将 命令 设置为 npx uranium-tools-mcp@latest。添加环境变量 URANIUM_API_KEY 并输入您的 API 密钥。点击 "添加扩展"。
LM Studio
#### 点击按钮安装:
[](https://lmstudio.ai/install-mcp?name=uranium&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyJ1cmFuaXVtLXRvb2xzLW1jcEBsYXRlc3QiXSwiZW52Ijp7IlVSQU5JVU1fQVBJX0tFWSI6InlvdXJfYXBpX2tleV9oZXJlIn19)
或手动安装:
转到右侧边栏的 程序 -> 安装 -> 编辑 mcp.json。使用上述标准配置并输入您的 API 密钥。
opencode
遵循 MCP 服务器 [文档](https://opencode.ai/docs/mcp-servers/)。例如,在 `~/.config/opencode/opencode.json` 中:
```json
{
"$schema": "https://opencode.ai/config.json",
"mcp": {
"uranium": {
"type": "local",
"command": [
"npx",
"uranium-tools-mcp@latest"
],
"env": {
"URANIUM_API_KEY": "your_api_key_here"
},
"enabled": true
}
}
}
```
Qodo Gen
在 VSCode 或 IntelliJ 中打开 [Qodo Gen](https://docs.qodo.ai/qodo-documentation/qodo-gen) 聊天面板 → 连接更多工具 → + 添加新的 MCP → 粘贴上述标准配置并输入您的 API 密钥。
点击 `保存`。
VS Code
#### 点击按钮安装:
[](https://insiders.vscode.dev/redirect?url=vscode%3Amcp%2Finstall%3F%257B%2522uranium%2522%253A%257B%2522command%2522%253A%2522npx%2522%252C%2522args%2522%253A%255B%2522uranium-tools-mcp%2540latest%2522%255D%252C%2522env%2522%253A%257B%2522URANIUM_API_KEY%2522%253A%2522your_api_key_here%2522%257D%257D%257D) [](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Amcp%2Finstall%3F%257B%2522uranium%2522%253A%257B%2522command%2522%253A%2522npx%2522%252C%2522args%2522%253A%255B%2522uranium-tools-mcp%2540latest%2522%255D%252C%2522env%2522%253A%257B%2522URANIUM_API_KEY%2522%253A%2522your_api_key_here%2522%257D%257D%257D)
或手动安装:
遵循 MCP 安装 指南,使用上述标准配置。您也可以使用 VS Code CLI 安装 Uranium MCP 服务器:
code --add-mcp '{"name":"uranium","command":"npx","args":["uranium-tools-mcp@latest"],"env":{"URANIUM_API_KEY":"your_api_key_here"}}'
安装后,Uranium MCP 服务器将可在 VS Code 中与您的 GitHub Copilot 代理一起使用。
Windsurf
遵循 Windsurf MCP [文档](https://docs.windsurf.com/windsurf/cascade/mcp)。使用上述标准配置并输入您的 API 密钥。
✨ 主要特性
- 快速高效的 NFT 管理:直接与 Uranium API 集成,实现即时操作。
- 多集合支持:无缝管理 ERC721 和 ERC1155 NFT 集合。
- 基于文件的资产创建:直接上传图像、视频、音频和文档作为 NFT。
- 批量操作:通过分页跨多个集合列出和过滤资产。
📦 安装指南
环境变量
URANIUM_API_KEY(必需):您从 portal.uranium.pro 获取的 Uranium API 密钥。
URANIUM_BASE_URL(可选):API 基础 URL。默认为 https://gw.urnm.pro。
示例配置
{
"mcpServers": {
"uranium": {
"command": "npx",
"args": ["uranium-tools-mcp@latest"],
"env": {
"URANIUM_API_KEY": "your_api_key_here"
}
}
}
}
本地安装
如果您更喜欢本地安装:
npm install -g uranium-tools-mcp
pnpm add -g uranium-tools-mcp
yarn global add uranium-tools-mcp
然后在配置中使用 uranium-tools-mcp 代替 npx uranium-tools-mcp@latest。
💻 使用示例
工具
此 MCP 服务器提供了 4 个主要的 NFT 管理工具:
集合管理
#### list_collections
- **描述**:列出所有用户集合(个人、公共和外部)。
- **参数**:无。
create_collection
- 描述:创建一个新的 NFT 集合。
- 参数:
name(字符串,必需):集合名称(3 - 30 个字符,字母、数字和 [_.-] 符号)[最小长度:3,最大长度:30]。
symbol(字符串,必需):集合符号(3 - 30 个字符,字母、数字和下划线)[最小长度:3,最大长度:30]。
type(字符串,枚举:ERC721,ERC1155,必需):集合类型:ERC721(单个 NFT)或 ERC1155(多代币)。
资产管理
#### list_assets
- **描述**:列出资产,并可选择按集合、搜索和分页进行过滤。
- **参数**:
- `contractId`(字符串,可选):按集合 ID 过滤资产。
- `page`(数字,可选):页码(默认:1)[最小值:1,默认值:1]。
- `pageSize`(数字,可选):每页的资产数量(默认:20,最大值:100)[最小值:1,最大值:100,默认值:20]。
- `sortBy`(字符串,可选):排序字段(默认:createdAt)[默认值:"createdAt"]。
- `order`(字符串,枚举:asc,desc,可选):排序顺序(默认:asc)[默认值:"asc"]。
- `quickFilter`(字符串,可选):用于按标题过滤资产的搜索文本。
create_asset
- 描述:从本地文件或 Base64 数据创建一个新的 NFT 资产。
- 参数:
filePath(字符串,可选):媒体文件的绝对路径(适用于本地文件)。
fileData(字符串,可选):Base64 编码的文件数据(适用于 Claude Desktop)。
fileName(字符串,可选):原始文件名(使用 fileData 时必需)。
mimeType(字符串,可选):文件的 MIME 类型(使用 fileData 时必需,例如 'image/png')。
contractId(字符串,必需):要铸造资产的集合 ID。
title(字符串,必需):资产标题(3 - 120 个字符)[最小长度:3,最大长度:120]。
description(字符串,可选):资产描述(可选,最大 255 个字符)[最大长度:255]。
location(字符串,可选):资产创建的位置(可选,最大 100 个字符)[最大长度:100]。
editions(数字,可选):版本数量(仅适用于 ERC1155 集合,1 - 1000)[最小值:1,最大值:1000]。
shareWithCommunity(布尔值,可选):使资产可被社区发现(可选,默认:false)[默认值:false]。
支持的文件格式
- 图像:JPG、JPEG、PNG、GIF、WebP、SVG。
- 视频:MP4、WebM、MOV、AVI。
- 音频:MP3、WAV、OGG。
- 文档:PDF、TXT。
🔧 技术细节
开发
从源代码构建
- 克隆仓库:
git clone https://github.com/xkelxmc/uranium-mcp.git
cd uranium-mcp
- 安装依赖:
npm install
- 构建项目:
npm run build
开发命令
npm run dev
npm run build
npm start
npm run clean
测试
使用 MCP 检查器
使用 MCP 检查器 测试您的 MCP 服务器:
npx @modelcontextprotocol/inspector uranium-tools-mcp
npm run build:dev
npx @modelcontextprotocol/inspector node build/index.js
开发测试
npm run dev:stdio
npm run dev:http
npm run mcp:inspect
故障排除
常见问题
- API 密钥无效:确保您的 API 密钥有效,并在 portal.uranium.pro 具有必要的权限。
- 连接错误:检查
URANIUM_BASE_URL 是否正确(默认为 https://gw.urnm.pro)。
- 文件上传问题:确保文件路径是绝对路径,并且文件存在。
- 集合创建失败:验证集合名称和符号是否遵循所需格式(3 - 30 个字符,字母数字和下划线)。
项目结构
src/
├── api/ # 来自 Raycast 的 Uranium API 完整副本
├── utils/ # 用于验证、格式化等的实用工具
├── models/ # 用于处理文件的上传原语
├── tools/ # MCP 工具
├── server.ts # MCP 服务器配置
├── index.ts # 入口点
└── config.ts # API 和 MCP 配置
📄 许可证
待补充
📚 详细文档
支持
如有问题和疑问: