MCP server for the Artguru Open API Platform.
Project description
Artguru MCP
Artguru MCP is a Python MCP server for the Artguru Open API Platform. It wraps Artguru image APIs and exposes them as MCP tools for clients such as Codex, Claude Desktop, and other MCP-compatible agents.
中文版本请见 README.zh-CN.md.
Requirements
- Python 3.11 or later.
- An Artguru API key.
Installation
Install the package from PyPI:
pip install artguru-mcp
MCP client configuration
Add the server to your MCP client configuration:
{
"mcpServers": {
"artguru-mcp": {
"command": "artguru-mcp",
"env": {
"ARTGURU_API_KEY": "your_api_key"
}
}
}
}
You can also pass api_key directly to each tool. Using ARTGURU_API_KEY is
recommended because it keeps secrets out of prompts and tool arguments.
Tools
artguru_get_credits: Get total, used, and remaining account credits.artguru_upload_image: Upload a local image and return an Artguru image URL.artguru_photo_enhance: Start a photo enhancement task from an image URL.artguru_image_to_image: Start an image-to-image generation task.artguru_get_task_status: Check a task by business type and task ID.artguru_photo_enhance_with_progress: Upload a local image, create an enhancement task, poll status, and return every step insteps.artguru_image_to_image_with_progress: Upload a local image, create an image-to-image task, poll status, and return every step insteps.
Use the _with_progress tools when you want the client to show the full
workflow. Their response includes step events such as upload_started,
upload_succeeded, task_create_started, task_create_succeeded,
poll_started, poll_attempt, poll_succeeded, poll_failed, and
poll_timeout.
If upload, task creation, or polling fails, the tool returns
status: "FAILED" with a failure event and an error message. If polling
does not finish within max_poll_attempts, the tool returns
status: "TIMEOUT".
Environment variables
ARTGURU_API_KEY: Required Artguru API key.ARTGURU_BASE_URL: Optional API base URL. Defaults tohttps://api.artguru.ai/.
Development
Install development dependencies and run checks with uv:
uv run --extra dev python -m pytest
uv run --extra dev ruff check .
uv build
Project links
- Documentation: https://x6oynfyxq3.apifox.cn/authentication-7269269m0
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file artguru_mcp-0.1.0.tar.gz.
File metadata
- Download URL: artguru_mcp-0.1.0.tar.gz
- Upload date:
- Size: 53.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b4040d7d65cc15acfcbc1d0b48cb194f992ac79c6860c9140b2f4adce88c9a1b
|
|
| MD5 |
b778728c6b698ffdd2c41d905bd478d0
|
|
| BLAKE2b-256 |
dcf153543b4dd8f5cc014fd8998acfa26eabad7e048afc0667c2e93516e47e81
|
File details
Details for the file artguru_mcp-0.1.0-py3-none-any.whl.
File metadata
- Download URL: artguru_mcp-0.1.0-py3-none-any.whl
- Upload date:
- Size: 8.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c5a1749826d7a48a32ccd0b990bd7fc0dc1a08a87fe31aa43a3b000035e5cb94
|
|
| MD5 |
635b73b4e1d82c605f59d030e1faf894
|
|
| BLAKE2b-256 |
67de96b2132804c1d19d8fbaaa9e9689292dcf6be1da7950269cb56bbb329c40
|