Skip to main content

VolcEngine ImageX MCP

Project description

Volcengine ImageX MCP

Volcengine ImageX 的 Model Context Protocol (MCP) Server 实现

项目简介

Volcengine ImageX MCP是一个基于Model Context Protocol的 MCP-server, 它将 Volcengine 服务集成到LLM模型上下文中,使大模型能够直接上传和处理图片资源。

功能特点

  • 提供多种资源访问接口,便于LLM获取veImageX服务信息、图片资源等
  • 实现了多个veImageX功能的工具封装,包括上传图片、文生图、画质增强、画质评估、漫画风格、智能扩展等
  • 提供多种预定义提示模板,帮助LLM更好地理解和使用veImageX功能

安装

环境要求

  • Python 3.11+
  • 火山引擎账号及AccessKey/SecretKey

安装依赖

uv venv
source .venv/bin/activate
uv pip install -e .

环境变量配置

cp .env.example .env 

修改根目录的.env.example文件,并配置以下环境变量

VOLCENGINE_ACCESS_KEY=your_access_key
VOLCENGINE_SECRET_KEY=your_secret_key
SERVICE_ID=your_service_id
DOMAIN=your_domain

或者在集成 Mcp Server 的时候 通过环境变量配置

{
  "mcpServers": {
    "veimagex": {
      // ...
      "env": {
        "VOLCENGINE_ACCESS_KEY": "Your Volcengine AK",
        "VOLCENGINE_SECRET_KEY": "Your Volcengine SK",
        "SERVICE_ID": "Your Service ID",
        "DOMAIN": "Your Domain"
      }
    }
  }
}

使用方法

在 Mcp Client 中集成

在 mcp client 中配置 mcp 服务, (还没有发布包 暂时用 sh命令 运行 server 脚本,后续如果发布包 则用 uvx 运行 server 脚本), 配置的 MCP JSON:

本地开发

{
  "mcpServers": {
    "volcengine": {
      "command": "uvx",
      "args": ["--from", "YOUR_PROJECT_ABSOLUTE_PATH", "veimagex-mcp"],
    }
  }
}

Pypi

{
  "mcpServers": {
    "volcengine": {
      "command": "uvx",
      "args": ["veimagex-mcp"],
    }
  }
}

使用 @modelcontextprotocol/inspector 调试

sh ./scripts/debug.sh

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

veimagex_mcp-0.1.1.tar.gz (11.4 kB view details)

Uploaded Source

Built Distribution

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

veimagex_mcp-0.1.1-py3-none-any.whl (11.3 kB view details)

Uploaded Python 3

File details

Details for the file veimagex_mcp-0.1.1.tar.gz.

File metadata

  • Download URL: veimagex_mcp-0.1.1.tar.gz
  • Upload date:
  • Size: 11.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for veimagex_mcp-0.1.1.tar.gz
Algorithm Hash digest
SHA256 6e8745f63fca33a354ea12208ca3a717763327bc3c190f2165f74f9496a42c39
MD5 da7b7bc07c4033167ceb2adc1ef8e3d0
BLAKE2b-256 87e4bf45bf8db08596c8577524ad97c5662a7717f4942f71946bbd3d2527658e

See more details on using hashes here.

File details

Details for the file veimagex_mcp-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: veimagex_mcp-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 11.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for veimagex_mcp-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a2343587809a7e45ded5ef699e8982ff6bac12c787c293a3981a503d84eff7f9
MD5 98531e6c76044c0217d5239c4ffc51d4
BLAKE2b-256 371fe6b4b402357bb395ceffc02de71bd4c66a148792831ba3a97b18fffc8b87

See more details on using hashes here.

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