使用说明
PixelDojo MCP服务器
一种模型上下文协议（MCP）服务器，使用 PixelDojo的 API与合作 Anthropic Claude桌面客户端和其他MCP兼容主机。
特性
PixelDojo MCP服务器允许像Claude这样的AI助手：
- 使用各种PixelDojo模型生成AI图像
- 选择不同的宽高比、图像格式和质量设置
- 查看可用型号和功能
- 检查信用余额和使用情况
工具
服务器提供了几个工具来与PixelDojo API交互：
1. pixeldojo_generate_image
使用PixelDojo AI图像生成功能生成图像。
参数:
prompt（必填）：要生成的图像的文本描述model（可选）：要使用的型号（例如，“flux-pro”、“flux-1.1-pro”、“flux-1.1-pro-ultra”）aspect_ratio（可选）：图像宽高比（例如，“1:1”、“16:9”、“9:16”）num_outputs（可选）：要生成的图像数量（默认值：1）seed（可选）：随机种子以获得可重复的结果output_format（可选）：输出格式（png、jpg、webp）output_quality（可选）：输出质量（1-100）
2. pixeldojo_describe_models
获取有关可用型号的信息。
参数:
model_id（可选）：获取详细信息的特定型号ID
3. pixeldojo_get_credits
获取PixelDojo帐户的当前信用余额信息。
安装
先决条件
- Python 3.11或更高版本
- 活动的PixelDojo订阅和API密钥
- 生成图像的学分（每张图像1学分；flux-1.1-pro-ultra 1.5学分）
使用紫外线（推荐）
紫外线的 是一个快速的Python包安装程序和解析器。
# Install UV if you don't have it
curl -LsSf https://astral.sh/uv/install.sh | sh
# Install the package
uv pip install pixeldojo-mcp
使用pip
pip install pixeldojo-mcp
使用Homebrew（macOS）
# Add the tap (only needed once)
brew tap mariusSil/pixeldojo
# Install the package
brew install pixeldojo-mcp
这是团队使用的推荐安装方法，因为它提供了最简单的安装体验。
使用Windsurf进行设置
-
从获取PixelDojo API密钥 PixelDojo 网站.
-
有两种方法可以配置Windsurf以使用PixelDojo MCP服务器：
选项1：使用Windsurf用户界面（推荐）
-
通过导航到以下位置打开Windsurf编辑器设置：
- macOS：设置→ 扩展→ MCP服务器
- Windows/Linux：文件→ 偏好设置→ 设置→ 扩展→ MCP服务器
-
点击“添加新服务器”，填写以下详细信息：
- 服务器名称：pixeldojo mcp
- 命令：/opt/homebrew/bin/pixeldojo mcp（或homebrew安装它的路径）
- 环境变量:
- 名称：PIXELDOJO_API_KEY
- 值：YOUR_API_KEY_HERE
选项2：直接编辑settings.json
-
打开您的Windsurf settings.json文件：
macOS:
nano ~/Library/Application\ Support/Windsurf/User/settings.json视窗:
notepad %APPDATA%\Windsurf\User\settings.json -
使用PixelDojo配置添加或更新“mcpServers”部分：
"mcpServers": { "pixeldojo-mcp": { "command": "/opt/homebrew/bin/pixeldojo-mcp", "env": { "PIXELDOJO_API_KEY": "YOUR_API_KEY_HERE" } } }
-
-
保存文件并重新启动Windsurf。
使用Claude Desktop进行设置
-
从获取PixelDojo API密钥 PixelDojo 网站.
-
编辑您的Claude Desktop配置文件：
macOS:
nano ~/Library/Application\ Support/Claude/claude_desktop_config.json视窗:
notepad %APPDATA%\Claude\claude_desktop_config.json -
添加以下配置（如果文件不存在，则创建该文件）：
{ "mcpServers": { "pixeldojo-mcp": { "env": { "PIXELDOJO_API_KEY": "YOUR_API_KEY_HERE" }, "command": "pixeldojo-mcp" } } } -
保存文件并重新启动Claude Desktop。
使用光标进行设置
-
从获取PixelDojo API密钥 PixelDojo 网站.
-
编辑Cursor配置文件：
macOS:
nano ~/.cursor/mcp.json视窗:
notepad %USERPROFILE%\.cursor\mcp.json -
添加以下配置（如果文件不存在，则创建该文件）：
{ "pixeldojo-mcp": { "env": { "PIXELDOJO_API_KEY": "YOUR_API_KEY_HERE" }, "command": "/opt/homebrew/bin/pixeldojo-mcp" } } -
保存文件并重新启动Cursor。
环境变量
需要以下环境变量：
PIXELDOJO_API_KEY：您的PixelDojo API密钥
团队部署指南
要为您的开发团队部署此功能，请执行以下步骤：
-
设置Homebrew Tap存储库:
- 确保您的团队可以访问mariusSil/homebrew pixeldojo存储库
- 存储库应包含pixeldojo-mcp.rb公式
-
团队安装: 与您的团队分享以下简单说明：
# Add the tap brew tap mariusSil/pixeldojo # Install the PixelDojo MCP server brew install pixeldojo-mcp # Configure in Windsurf: Settings → Extensions → MCP Servers # Add server with the following details: # - Server Name: pixeldojo-mcp # - Command: /opt/homebrew/bin/pixeldojo-mcp # - Environment Variables: PIXELDOJO_API_KEY=your_api_key_here -
API密钥管理:
- 每个团队成员都需要自己的PixelDojo API密钥
- 企业用户可以联系PixelDojo获取团队许可选项
例子
使用Windsurf生成图像
设置好服务器后，您可以让Windsurf中的Cascade为您生成图像：
“你能用PixelDojo生成一幅有山脉和湖泊的美丽风景图吗？”
Cascade将使用pixeldojo_generate_image工具并将生成的图像呈现给您。
使用Claude Desktop生成图像
设置好服务器后，您可以让Claude为您生成图像：
“你能用PixelDojo生成一幅有山脉和湖泊的美丽风景图吗？”
Claude将使用pixeldojo_generate_image工具并将生成的图像呈现给您。
高级图像生成
您可以指定高级参数：
“使用PixelDojo的flux-1.1-pro-ultra模型，以16:9的纵横比，在夜晚用霓虹灯生成一个赛博朋克城市的图像。”
Claude将把这些参数传递给工具。
检查您的信用余额
您可以询问您的信用余额：
“我还有多少PixelDojo积分？”
Claude将使用pixeldojo_get_credits工具检查您的余额。
安全最佳实践
- 永远不要在公共存储库或客户端代码中公开API密钥
- 定期旋转API密钥
- 使用环境变量存储API密钥
- 在服务器上设置适当的CORS策略
开发中
有关对该项目的贡献，请参阅我们的 实施_计划.md 文件。
许可证
麻省理工学院
