Skip to main content

基于火山引擎 Seedream API 的 MCP 工具,支持 AI 图像生成功能

Project description

Seedream 4.0、4.5 和 5.0 MCP 生图工具

Ask Zread
Version PyPI Python License Powered by Codex&GLM

Seedream MCP

基于火山引擎 Seedream 4.0、4.5 和 5.0 API 的 MCP 工具,支持 AI 图像生成。

⚡ 快速安装

1. 前置准备

安装 uv(包含 uvx 命令):

# macOS / Linux
curl -LsSf https://astral.sh/uv/install.sh | sh

# Windows (PowerShell)
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

火山引擎控制台获取 API 密钥,通过环境变量 ARK_API_KEY 提供。

2. 一键启动

# 通过环境变量提供密钥(推荐)
ARK_API_KEY=your_api_key_here uvx seedream-image-mcp

# 也可显式指定模型、尺寸等运行参数
ARK_API_KEY=your_api_key_here uvx seedream-image-mcp --model doubao-seedream-5.0 --default-size 2K

uvx 自动从 PyPI 拉取最新版本并在隔离环境运行——无需 clone 仓库、无需手动创建虚拟环境、无需安装依赖。

3. 可选:Docker Compose

# 下载 docker-compose.yml
curl -O https://raw.githubusercontent.com/tengmmvp/Seedream_MCP/main/docker-compose.yml

# 启动服务
ARK_API_KEY=your_api_key_here docker-compose up -d

🔧 客户端配置

推荐通过 env 注入 ARK_API_KEY,避免把密钥写进 args(命令行参数会出现在进程列表中,存在泄露风险)。

Claude Desktop

编辑 claude_desktop_config.json

{
  "mcpServers": {
    "seedream": {
      "command": "uvx",
      "args": ["seedream-image-mcp"],
      "env": { "ARK_API_KEY": "your_api_key_here" }
    }
  }
}

Claude Code(命令行一键注册)

claude mcp add seedream --env ARK_API_KEY=your_api_key_here -- uvx seedream-image-mcp

Cursor

在项目根目录创建 .cursor/mcp.json

{
  "mcpServers": {
    "seedream": {
      "command": "uvx",
      "args": ["seedream-image-mcp"],
      "env": { "ARK_API_KEY": "your_api_key_here" }
    }
  }
}

Cline / 其他 stdio 客户端

通用配置(command + args + env 字段同上)。Cline 编辑 cline_mcp_settings.json

{
  "mcpServers": {
    "seedream": {
      "command": "uvx",
      "args": ["seedream-image-mcp"],
      "env": { "ARK_API_KEY": "your_api_key_here" }
    }
  }
}

需要指定模型/尺寸时,追加到 args,例如 ["seedream-image-mcp", "--model", "doubao-seedream-5.0"]

配置后重启对应客户端即可使用。

⚙️ 启动参数

--api-key TEXT                                     # API 密钥(可选,推荐用环境变量 ARK_API_KEY)
--model [doubao-seedream-5.0|doubao-seedream-5.0-lite|doubao-seedream-4.5|doubao-seedream-4.0]
                                                 # 模型选择 (默认: doubao-seedream-5.0)
--default-size [1K|2K|3K|4K|<宽>x<高>]            # 图像尺寸 (默认: 2K,需与模型兼容)
--watermark                                        # 启用水印
--log-level [DEBUG|INFO|WARNING|ERROR]             # 日志级别
--transport [stdio|sse|streamable-http]            # MCP 传输方式 (默认: stdio)
--mount-path TEXT                                  # SSE 挂载路径(仅 transport=sse 生效)
--config-file TEXT                                 # 自定义 .env 配置文件路径

使用示例

# 基础使用
ARK_API_KEY=your_key uvx seedream-image-mcp

# 使用自定义配置文件
ARK_API_KEY=your_key uvx seedream-image-mcp --config-file ./my-config.env

# 使用 Seedream 4.0 模型
ARK_API_KEY=your_key uvx seedream-image-mcp --model doubao-seedream-4.0

# 高质量图像 + 调试模式
ARK_API_KEY=your_key uvx seedream-image-mcp --model doubao-seedream-4.5 --default-size 4K --log-level DEBUG

🎨 功能特性

  • 文生图:文本生成图像
  • 图文生图:图像转换风格
  • 多图融合:融合多张图片
  • 组图输出:生成图像序列
  • 图片浏览:本地图片文件浏览

🛠️ 可用工具

1. seedream_text_to_image - 文生图

根据文本提示词生成图像

参数:

  • prompt (必需) - 图像生成的文本提示词,建议不超过 300 个汉字或 600 个英文单词
  • optimize_prompt_options (可选) - 提示词优化选项,支持 mode: "standard" 或 "fast"
  • size (可选) - 图像尺寸:1K2K3K4K<宽>x<高> 像素值,默认使用配置文件值,需与所选模型兼容
  • watermark (可选) - 是否添加水印,默认使用配置文件值(默认 false)
  • response_format (可选) - 响应格式:urlb64_json,默认url
  • output_format (可选) - 输出文件格式,仅 doubao-seedream-5.0 支持 jpegpng
  • stream (可选) - 是否启用流式输出,默认false
  • tools (可选) - 模型工具配置,仅 doubao-seedream-5.0 支持,例如 [{"type":"web_search"}]
  • request_count (可选) - 并行请求次数,范围 1-4,默认 1
  • parallelism (可选) - 并行度上限,范围 1-4,默认 min(request_count, 4)
  • auto_save (可选) - 是否自动保存到本地,默认使用全局配置(默认 true)
  • save_path (可选) - 自定义保存目录路径
  • custom_name (可选) - 自定义文件名前缀

2. seedream_image_to_image - 图文生图

根据输入图像和文本提示生成新图像

参数:

  • prompt (必需) - 图像修改要求或风格转换指令,建议不超过 300 个汉字或 600 个英文单词
  • optimize_prompt_options (可选) - 提示词优化选项,支持 mode: "standard" 或 "fast"
  • image (必需) - 输入图像的 URL 或本地文件路径
  • size (可选) - 图像尺寸:1K2K3K4K<宽>x<高> 像素值,默认使用配置文件值,需与所选模型兼容
  • watermark (可选) - 是否添加水印,默认使用配置文件值(默认 false)
  • response_format (可选) - 响应格式:urlb64_json,默认url
  • output_format (可选) - 输出文件格式,仅 doubao-seedream-5.0 支持 jpegpng
  • stream (可选) - 是否启用流式输出,默认false
  • tools (可选) - 模型工具配置,仅 doubao-seedream-5.0 支持,例如 [{"type":"web_search"}]
  • request_count (可选) - 并行请求次数,范围 1-4,默认 1
  • parallelism (可选) - 并行度上限,范围 1-4,默认 min(request_count, 4)
  • auto_save (可选) - 是否自动保存到本地,默认使用全局配置(默认 true)
  • save_path (可选) - 自定义保存目录路径
  • custom_name (可选) - 自定义文件名前缀

3. seedream_multi_image_fusion - 多图融合

将多张图像融合生成新图像

参数:

  • prompt (必需) - 图像融合要求或风格指令,建议不超过 300 个汉字或 600 个英文单词
  • optimize_prompt_options (可选) - 提示词优化选项,支持 mode: "standard" 或 "fast"
  • image (必需) - 输入图像 URL 或本地文件路径列表(2-14 张图像)
  • size (可选) - 图像尺寸:1K2K3K4K<宽>x<高> 像素值,默认使用配置文件值,需与所选模型兼容
  • watermark (可选) - 是否添加水印,默认使用配置文件值(默认 false)
  • response_format (可选) - 响应格式:urlb64_json,默认url
  • output_format (可选) - 输出文件格式,仅 doubao-seedream-5.0 支持 jpegpng
  • stream (可选) - 是否启用流式输出,默认false
  • tools (可选) - 模型工具配置,仅 doubao-seedream-5.0 支持,例如 [{"type":"web_search"}]
  • request_count (可选) - 并行请求次数,范围 1-4,默认 1
  • parallelism (可选) - 并行度上限,范围 1-4,默认 min(request_count, 4)
  • auto_save (可选) - 是否自动保存到本地,默认使用全局配置(默认 true)
  • save_path (可选) - 自定义保存目录路径
  • custom_name (可选) - 自定义文件名前缀

4. seedream_sequential_generation - 组图输出

连续生成多张图像,支持文生组图、单图生组图、多图生组图

参数:

  • prompt (必需) - 图像生成的文本提示词,应明确指明生成数量和内容,建议不超过 300 个汉字或 600 个英文单词
  • optimize_prompt_options (可选) - 提示词优化选项,支持 mode: "standard" 或 "fast"
  • image (可选) - 参考图像,支持单张图片(字符串)或多张图片(数组);参考图最多 14 张,且参考图数量与 max_images 之和不超过 15
  • size (可选) - 图像尺寸:1K2K3K4K<宽>x<高> 像素值,默认使用配置文件值,需与所选模型兼容
  • watermark (可选) - 是否添加水印,默认使用配置文件值(默认 false)
  • max_images (可选) - 最大生成图像数量,范围 1-15,默认 15
  • response_format (可选) - 响应格式:urlb64_json,默认url
  • output_format (可选) - 输出文件格式,仅 doubao-seedream-5.0 支持 jpegpng
  • stream (可选) - 是否启用流式输出,默认false
  • tools (可选) - 模型工具配置,仅 doubao-seedream-5.0 支持,例如 [{"type":"web_search"}]
  • request_count (可选) - 并行请求次数,范围 1-4,默认 1
  • parallelism (可选) - 并行度上限,范围 1-4,默认 min(request_count, 4)
  • auto_save (可选) - 是否自动保存到本地,默认使用全局配置(默认 true)
  • save_path (可选) - 自定义保存目录路径
  • custom_name (可选) - 自定义文件名前缀

5. seedream_browse_images - 图片浏览

浏览工作区中的图片文件,获取文件路径用于图像生成

参数:

  • directory (可选) - 要浏览的目录路径,默认当前目录
  • recursive (可选) - 是否递归搜索子目录,默认true
  • max_depth (可选) - 最大搜索深度,范围 1-10,默认 3
  • limit (可选) - 返回的最大文件数量,范围 1-200,默认 50
  • format_filter (可选) - 过滤特定图片格式,如['.jpeg', '.png']
  • show_details (可选) - 是否显示详细文件信息,默认false

🆘 常见问题

Q: uvx 命令不存在?

curl -LsSf https://astral.sh/uv/install.sh | sh

Q: 如何获取 API 密钥? 访问 火山引擎控制台 创建密钥

Q: Docker 服务无法启动? 确保设置了环境变量:

# Linux/macOS
export ARK_API_KEY=your_key
docker-compose up -d

# Windows
$env:ARK_API_KEY="your_key"
docker-compose up -d

🧪 本地开发

# 克隆仓库
git clone https://github.com/tengmmvp/Seedream_MCP
cd Seedream_MCP

# 安装依赖(开发模式)
uv sync --dev

# 创建 .env 文件
cp .env.example .env
# 编辑 .env 文件,添加您的 API 密钥

# 启动服务
uv run python -m seedream_mcp.server

# 或直接使用 API 密钥启动
uv run python -m seedream_mcp.server --api-key your_key

⚙️ 环境变量配置

主要配置项(详见 .env.example):

配置优先级:MCP 客户端显式配置(命令行参数) > 运行时系统环境变量 > .env 文件 > 默认值。

.env 加载规则:

  • 使用 --config-file 时:仅加载指定文件。
  • 未指定 --config-file 时:按“项目根 .env -> 当前工作目录 .env”顺序合并,后者覆盖前者。
  • .env 会注入进程环境变量供运行时读取,但不会覆盖已存在的系统环境变量。
# 必需配置
ARK_API_KEY=your_api_key_here

# 模型配置
SEEDREAM_MODEL_ID=doubao-seedream-5-0-260128

# 默认值
SEEDREAM_DEFAULT_SIZE=2K
SEEDREAM_DEFAULT_WATERMARK=false

# 自动保存
SEEDREAM_AUTO_SAVE_ENABLED=true
SEEDREAM_AUTO_SAVE_BASE_DIR=./seedream_images
SEEDREAM_AUTO_SAVE_DATE_FOLDER=true
SEEDREAM_AUTO_SAVE_CLEANUP_DAYS=30

👥 贡献者

项目创建者

重要贡献者

  • @caoergou - 通过 PR #2 贡献了 uvx 支持、Docker 容器化配置、GitHub Actions 自动化发布流程,极大简化了项目的安装与部署体验

参与贡献

欢迎提交 Issue 和 Pull Request!请查看 GitHub Issues 了解当前的讨论和需求。

🌟 如果您希望参与开发,请先在 Issues 中讨论您的想法!

📄 许可证

这个项目基于 MIT 许可证开源。更多信息请查看 LICENSE 文件。

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

seedream_image_mcp-1.2.7.tar.gz (66.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

seedream_image_mcp-1.2.7-py3-none-any.whl (83.4 kB view details)

Uploaded Python 3

File details

Details for the file seedream_image_mcp-1.2.7.tar.gz.

File metadata

  • Download URL: seedream_image_mcp-1.2.7.tar.gz
  • Upload date:
  • Size: 66.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for seedream_image_mcp-1.2.7.tar.gz
Algorithm Hash digest
SHA256 c81fb8181c77dd862b47e2b0196f4ea080bd5b2e194268135e82a4253db97418
MD5 7b11e2d414e3c76e2c1f86a57f402f06
BLAKE2b-256 37d7a03fed5c03e16d3681ab1b99dcbd3ef36e830a3242744e33fd40af8f5a37

See more details on using hashes here.

Provenance

The following attestation bundles were made for seedream_image_mcp-1.2.7.tar.gz:

Publisher: release.yml on tengmmvp/Seedream_MCP

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file seedream_image_mcp-1.2.7-py3-none-any.whl.

File metadata

File hashes

Hashes for seedream_image_mcp-1.2.7-py3-none-any.whl
Algorithm Hash digest
SHA256 6ffd9e9dd5d10e071117f9e7ba8cd7421deed7eecb776a1bc08248eb7e64fe8f
MD5 b5dabd2402dc9c2e209f21cfd907f82c
BLAKE2b-256 943ac5e48df04373e6d32147d40f57fc3c5813874a66fdf3a340b50b1cb8af4e

See more details on using hashes here.

Provenance

The following attestation bundles were made for seedream_image_mcp-1.2.7-py3-none-any.whl:

Publisher: release.yml on tengmmvp/Seedream_MCP

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page