Back to MCP directory
publicPublicdnsLocal runtime

ali-flux-mcp

阿里云DashScope API的MCP服务,提供图像生成、任务状态查询及下载功能

article

README

🚀 阿里云DashScope API的Model Context Protocol(MCP)服务器

这是一个基于TypeScript的MCP服务器,可与阿里云DashScope API进行交互,实现图像生成与本地保存功能。该服务器对核心MCP概念进行了演示,具备以下实用工具:

  • 借助阿里云DashScope API生成图像。
  • 检查图像生成任务的状态。
  • 下载生成的图像并保存至本地磁盘。

🚀 快速开始

此服务器是基于TypeScript构建的MCP服务器,用于和阿里云DashScope API交互,实现图像生成和本地保存功能。它能帮助你利用阿里云DashScope API完成图像生成任务,并将生成的图像保存到本地。

✨ 主要特性

工具

  • generate_image:使用阿里云DashScope API生成图像。
    • 必填参数:提示词(prompt)。
    • 可选参数:大小(size)、随机种子(seed)、步骤(steps)。
    • 功能:提交图像生成任务到DashScope API。
  • check_task_status:检查图像生成任务的状态。
    • 必填参数:任务ID(task_id)。
    • 功能:返回当前图像生成任务的状态。
  • download_image:下载生成的图像并保存到本地磁盘。
    • 必填参数:任务ID(task_id)。
    • 可选参数:自定义保存路径(save_path,必须是绝对路径)。
    • 可选参数:用于解析相对路径的基础目录(base_dir,默认为WORK_DIR环境变量)。
    • 功能:将所有生成的图像下载并保存到指定目录。

📦 安装指南

开发准备

先决条件

  • Node.js 和 npm。
  • 阿里云DashScope API密钥。

环境变量

  • DASHSCOPE_API_KEY:您的阿里云DashScope API密钥。
  • SAVE_DIR:保存生成图像的目录(默认:~/Desktop/flux-images)。
  • MODEL_NAME:DashScope模型名称(默认:flux-merged)。
  • WORK_DIR:工作目录(默认:process.cwd())。

项目搭建

  • 安装依赖
npm install
  • 构建服务器
npm run build
  • 开发时自动重建
npm run watch

安装配置

配置说明

要在Claude Desktop或其他兼容MCP的客户端上使用,请在相应配置文件中添加此服务器:

  • MacOS:~/Library/Application Support/Claude/claude_desktop_config.json
  • Windows:%APPDATA%/Claude/claude_desktop_config.json。
{
  "mcpServers": {
    "ali-flux": {
      "command": "/path/to/ali-flux/build/index.js",
      "env": {
        "DASHSCOPE_API_KEY": "your-api-key-here",
        "SAVE_DIR": "/custom/save/path" // 可选
      }
    }
  }
}

调试

由于MCP服务器通过stdio通信,调试可能具有挑战性。我们推荐使用MCP Inspector,它作为一个包脚本提供:

npm run inspector

Inspector将提供一个URL,用于在浏览器中访问调试工具。

help

Runtime guide

cloud

Hosted runtime

Hosted servers run from a provider-managed environment. You usually connect the MCP client to the hosted endpoint or follow the provider's authorization flow, without keeping a local process alive

  1. Open provider connection page
  2. Authorize or copy endpoint
  3. Connect from your MCP client
terminal

Local runtime / other methods

Local servers run on your own machine or infrastructure. You normally copy the server_config into your MCP client, install the required package, and provide env variables from env_schema when needed

  1. Copy server_config
  2. Install required package
  3. Fill env variables and restart client