volcengine/mcp-imagex

guide

VeImageX MCP is the Volcengine(火山引擎) ImageX(图片服务) MCP Server, an image processing assistant that helps users upload images, process images, distribute images, and obtain image URLs.

Before using VeImageX MCP, you need to know a few things:

1. For tools that need to pass in service_id and domain in the parameters, prioritize obtaining from environment variable as the default value. If no value is specified in the environment variable, prompt the user.

2. For tools that need to pass in template in the parameters, the default value of the template is tplv-service_id-image, where service_id needs to be replaced with the actual service_id, e.g., if the user's service_id is n9b2vwdhz3, use tplv-n9b2vwdhz3-image

3. upload_image is used to upload images, using local absolute paths - the tool will help you upload to Volcengine using fs. If you don't have this path, you try to find user's intent, or ask him.

4. If you need to process a local image, you should first upload the image to get the uri, then call the image processing tool.

5. If the result generated by the tool is a uri, automatically call get_image_url_by_store_uri to get an accessible URL and return it.

get_all_services_resource

Get list of all service information. Important information includes:

1. Domain Name - DomainName
2. Service ID - ServiceId
3. Service Name - ServiceName
4. Service Type - ServiceType: StaticRc (static hosting), Image (image processing)
5. Service Status - ServiceStatus

upload_image

Upload images to specified service.

Args: file_path: List of image file paths, use absolute path.

get_all_image_templates

Get all templates (tpl) for the Image service. Call this before getting image URLs to query the corresponding API service.

get_imagex_storage_files

Query and return all the resources stored under the corresponding service_id.

delete_imagex_upload_files

pass in a list of image uris and delete these images in the corresponding service. Args: uris: list of image uris to be deleted

get_image_url_by_store_uri

Get image access URL through URI.

Args: uri: The storage URI of the image

generate_image_by_text

Generate an image based on the text.

Args: text: The text to generate an image from

enhance_image_quality

Under the premise of ensuring consistency with the original image content, significantly improve the clarity.

Args: input_image_url: The input image url

convert_image_to_comic_style

Turn the input image into a comic style.

Args: input_image_url: The input image url

image_ocr

Recognize the text in the image.

Args: input_image_url: The input image url

expand_image

Expand the image to the surrounding area.

Args: input_image_url: The input image url

evaluate_image_quality

Evaluate the image quality. There will be NrScoreResult and FrScoreResult fields in the returned results. Summary of NrScoreResult and FrScoreResult Fields 1. NrScoreResult (No-Reference Image Quality Assessment) Purpose: Evaluates absolute image quality without requiring a reference image. Sub-fields: VqScore (0-100): Overall perceptual quality score (higher = better) Noise (0-100): Noise level (higher = more noise) Blur (0-100): Blurriness (higher = more blurred) Blockiness (0-100): Compression blocking artifacts Brightness (0-100): Image luminance level Contrast (0-100): Color contrast intensity AdvColor (0-100): Advanced color quality assessment Aesthetic (0-100): Aesthetic appeal score FaceDetect (0/1): Whether faces are detected FaceScore (0-100): Quality score of detected faces FaceNum: Number of faces detected TextDetect (0/1): Whether text is detected TextScore (0-100): Quality score of detected text TextNum: Number of text regions detected Use Case: Standalone quality assessment for single images.

2. FrScoreResult (Full-Reference Image Quality Assessment)
Purpose: Compares target image against a reference image.
Sub-fields:
Psnr (0-60): Peak Signal-to-Noise Ratio (higher = better)
Ssim (0-1): Structural Similarity Index
Vmaf (0-100): Video Multi-method Assessment Fusion score
DeltaE (0-100): Color difference metric (lower = better)
Fid (0-100): Feature similarity index
Nab (0-100): Noise and blur difference score
Requirements:
Requires reference image (ImageUrlRef)
Both images must have identical resolution
Use Case: Quality comparison between original and processed images.

Args: input_image_url: The input image url

get_note

获取参数描述

Args: func_name: 函数名

get_service_domains

本接口支持通过指定服务 ID 获取服务下所有域名信息。 Call steps:

1. Pass "get_service_domains" as an input parameter to invoke the get_note method to obtain the parameter description.
2. After obtaining the parameter description, invoke get_service_domains

describe_imagex_summary

本接口支持通过指定时间点以及服务 ID，查询本月用量概览，包括带宽、流量、存储、请求次数、基础图像处理。 Call steps:

1. Pass "describe_imagex_summary" as an input parameter to invoke the get_note method to obtain the parameter description.
2. After obtaining the parameter description, invoke describe_imagex_summary

describe_imagex_domain_traffic_data

本接口支持通过自定义时间段，来查询域名流量用量。 Call steps:

1. Pass "describe_imagex_domain_traffic_data" as an input parameter to invoke the get_note method to obtain the parameter description.
2. After obtaining the parameter description, invoke describe_imagex_domain_traffic_data

describe_imagex_domain_bandwidth_data

本接口支持通过自定义时间段，查询域名带宽用量。 Call steps:

1. Pass "describe_imagex_domain_bandwidth_data" as an input parameter to invoke the get_note method to obtain the parameter description.
2. After obtaining the parameter description, invoke describe_imagex_domain_bandwidth_data

describe_imagex_billing_request_cnt_usage

本接口支持通过自定义查询时间段，获取该时间段的附加组件通用请求次数。 Call steps:

1. Pass "describe_imagex_billing_request_cnt_usage" as an input parameter to invoke the get_note method to obtain the parameter description.
2. After obtaining the parameter description, invoke describe_imagex_billing_request_cnt_usage

describe_imagex_request_cnt_usage

本接口支持通过自定义查询时间段，查询该时间段的请求次数。 Call steps:

1. Pass "describe_imagex_request_cnt_usage" as an input parameter to invoke the get_note method to obtain the parameter description.
2. After obtaining the parameter description, invoke describe_imagex_request_cnt_usage

describe_imagex_base_op_usage

本接口支持通过自定义时间段，查询该时间段的图像基础处理量。 Call steps:

1. Pass "describe_imagex_base_op_usage" as an input parameter to invoke the get_note method to obtain the parameter description.
2. After obtaining the parameter description, invoke describe_imagex_base_op_usage

describe_imagex_compress_usage

本接口支持通过自定义查询时间段，查询该时间段的图像高效压缩量。 Call steps:

1. Pass "describe_imagex_compress_usage" as an input parameter to invoke the get_note method to obtain the parameter description.
2. After obtaining the parameter description, invoke describe_imagex_compress_usage

describe_imagex_screenshot_usage

本接口支持通过自定义查询时间段，查询该时间段的截帧用量。 Call steps:

1. Pass "describe_imagex_screenshot_usage" as an input parameter to invoke the get_note method to obtain the parameter description.
2. After obtaining the parameter description, invoke describe_imagex_screenshot_usage

describe_imagex_video_clip_duration_usage

本接口支持通过自定义查询时间段，查询该时间段的小视频转动图的视频转换时长用量。 Call steps:

1. Pass "describe_imagex_video_clip_duration_usage" as an input parameter to invoke the get_note method to obtain the parameter description.
2. After obtaining the parameter description, invoke describe_imagex_video_clip_duration_usage

describe_imagex_multi_compress_usage

本接口支持通过自定义查询时间段，查询该时间段的多文件压缩用量。 Call steps:

1. Pass "describe_imagex_multi_compress_usage" as an input parameter to invoke the get_note method to obtain the parameter description.
2. After obtaining the parameter description, invoke describe_imagex_multi_compress_usage

describe_imagex_edge_request

本接口支持通过自定义查询时间段，查询该时间段的边缘请求次数。 Call steps:

1. Pass "describe_imagex_edge_request" as an input parameter to invoke the get_note method to obtain the parameter description.
2. After obtaining the parameter description, invoke describe_imagex_edge_request

describe_imagex_edge_request_bandwidth

本接口支持通过自定义查询时间段，查询该时间段的边缘分发带宽用量。 Call steps:

1. Pass "describe_imagex_edge_request_bandwidth" as an input parameter to invoke the get_note method to obtain the parameter description.
2. After obtaining the parameter description, invoke describe_imagex_edge_request_bandwidth

describe_imagex_edge_request_traffic

本接口支持通过自定义查询时间段，查询该时间段的边缘分发流量用量。 Call steps:

1. Pass "describe_imagex_edge_request_traffic" as an input parameter to invoke the get_note method to obtain the parameter description.
2. After obtaining the parameter description, invoke describe_imagex_edge_request_traffic

describe_imagex_edge_request_regions

本接口支持通过自定义查询时间段，查询该时间段的边缘分发数据的地区列表。 Call steps:

1. Pass "describe_imagex_edge_request_regions" as an input parameter to invoke the get_note method to obtain the parameter description.
2. After obtaining the parameter description, invoke describe_imagex_edge_request_regions

describe_imagex_server_qps_usage

本接口支持通过自定义时间段，获取当前账号的数据处理服务 QPS 用量。 Call steps:

1. Pass "describe_imagex_server_qps_usage" as an input parameter to invoke the get_note method to obtain the parameter description.
2. After obtaining the parameter description, invoke describe_imagex_server_qps_usage

describe_imagex_hit_rate_traffic_data

本接口支持通过自定义查询时间段，查询该时间段的域名的 CDN 流量命中率用量数据。 Call steps:

1. Pass "describe_imagex_hit_rate_traffic_data" as an input parameter to invoke the get_note method to obtain the parameter description.
2. After obtaining the parameter description, invoke describe_imagex_hit_rate_traffic_data

describe_imagex_hit_rate_request_data

本接口支持通过自定义查询时间段，查询该时间段的域名的 CDN 请求次数命中率用量数据。 Call steps:

1. Pass "describe_imagex_hit_rate_request_data" as an input parameter to invoke the get_note method to obtain the parameter description.
2. After obtaining the parameter description, invoke describe_imagex_hit_rate_request_data

describe_imagexcdn_top_request_data

本接口支持获取按照流量/请求次数排序的数据列表，即按流量或请求次数由大到小排序后，访问量最靠前的域名/URL/Refer/客户端IP/UA/访问区域/运营商等数据。

• URL/Refer/客户端IP/UA 最多支持展示 Top 1000 的数据。
• 访问区域/运营商可展示展示全量数据。 Call steps:

1. Pass "describe_imagexcdn_top_request_data" as an input parameter to invoke the get_note method to obtain the parameter description.
2. After obtaining the parameter description, invoke describe_imagexcdn_top_request_data

describe_imagex_domain_bandwidth_ninety_five_data

本接口支持通过自定义时间段，查询域名的 95 峰值带宽用量。 Call steps:

1. Pass "describe_imagex_domain_bandwidth_ninety_five_data" as an input parameter to invoke the get_note method to obtain the parameter description.
2. After obtaining the parameter description, invoke describe_imagex_domain_bandwidth_ninety_five_data

describe_imagex_bucket_retrieval_usage

本接口支持通过自定义查询时间段，查询该时间段的每天资源占用量。 单次查询最大时间跨度为 93 天。 Call steps:

1. Pass "describe_imagex_bucket_retrieval_usage" as an input parameter to invoke the get_note method to obtain the parameter description.
2. After obtaining the parameter description, invoke describe_imagex_bucket_retrieval_usage

describe_imagex_source_request

本接口支持通过自定义查询时间段，查询该时间段的回源请求次数。 Call steps:

1. Pass "describe_imagex_source_request" as an input parameter to invoke the get_note method to obtain the parameter description.
2. After obtaining the parameter description, invoke describe_imagex_source_request

describe_imagex_source_request_bandwidth

本接口支持通过自定义查询时间段，查询该时间段的回源带宽用量。 Call steps:

1. Pass "describe_imagex_source_request_bandwidth" as an input parameter to invoke the get_note method to obtain the parameter description.
2. After obtaining the parameter description, invoke describe_imagex_source_request_bandwidth

describe_imagex_source_request_traffic

本接口支持通过自定义查询时间段，查询该时间段的回源流量用量。 Call steps:

1. Pass "describe_imagex_source_request_traffic" as an input parameter to invoke the get_note method to obtain the parameter description.
2. After obtaining the parameter description, invoke describe_imagex_source_request_traffic

describe_vpc_access_config

本接口将为您展示指定服务的内网访问功能的配置详情。 Call steps:

1. Pass "describe_vpc_access_config" as an input parameter to invoke the get_note method to obtain the parameter description.
2. After obtaining the parameter description, invoke describe_vpc_access_config