Skip to content

Commit a884ada

Browse files
committed
Clarify generate image unsupported action docs
1 parent 77163d4 commit a884ada

3 files changed

Lines changed: 8 additions & 8 deletions

File tree

MCPForUnity/Editor/Tools/AssetGen/GenerateImage.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ public static object HandleCommand(JObject @params)
2727
{
2828
case "generate": return Generate(p);
2929
case "remove_background":
30-
return new ErrorResponse("remove_background is not implemented in this version. Generate with transparency-capable models instead.");
30+
return new ErrorResponse("remove_background is not implemented in this version.");
3131
case "status": return Status(p);
3232
case "cancel": return Cancel(p);
3333
case "list_providers": return ListProviders();

Server/src/services/tools/generate_image.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,11 @@
2323
"textures/sprites into the Unity project. Bring-your-own-key: provider keys live "
2424
"in the editor's secure store and never cross the bridge.\n\n"
2525
"ACTIONS:\n"
26-
"- generate: Submit an image job (text->image or image->image). Returns { job_id } "
27-
"(sync providers resolve immediately); poll with the status action. Params: "
26+
"- generate: Submit an image job (text->image or image->image). Returns { job_id }; "
27+
"poll with the status action. Params: "
2828
"provider, mode (text|image), prompt, image_path|image_url, model, transparent, "
2929
"width, height, name, output_folder.\n"
30-
"- remove_background: Remove the background of image_path -> { job_id }.\n"
30+
"- remove_background: Unsupported in this version; returns an error instead of a job_id.\n"
3131
"- status: Poll an async job by job_id -> { state, progress, assetPath?, error? }.\n"
3232
"- cancel: Cancel an in-flight job by job_id.\n"
3333
"- list_providers: List configured image providers and capabilities (no key values)."
@@ -45,7 +45,7 @@ async def generate_image(
4545
provider: Annotated[str, "Provider id (fal, openrouter)."] | None = None,
4646
mode: Annotated[str, "Generation mode: text or image."] | None = None,
4747
prompt: Annotated[str, "Text prompt for text->image."] | None = None,
48-
image_path: Annotated[str, "Path to a source image for image->image / remove_background."] | None = None,
48+
image_path: Annotated[str, "Path to a source image for image->image mode."] | None = None,
4949
image_url: Annotated[str, "URL of a source image for image->image."] | None = None,
5050
model: Annotated[str, "Provider model id/slug (e.g. FLUX, gemini-2.5-flash-image)."] | None = None,
5151
transparent: Annotated[bool, "Mark the imported texture as alpha-is-transparency. NOTE: fal/FLUX "

website/docs/reference/tools/asset_gen/generate_image.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ description: "Generate 2D images with AI providers (fal.ai, OpenRouter) and impo
1515
Generate 2D images with AI providers (fal.ai, OpenRouter) and import them as textures/sprites into the Unity project. Bring-your-own-key: provider keys live in the editor's secure store and never cross the bridge.
1616

1717
ACTIONS:
18-
- generate: Submit an image job (text->image or image->image). Returns { job_id } (sync providers resolve immediately); poll with the status action. Params: provider, mode (text|image), prompt, image_path|image_url, model, transparent, width, height, name, output_folder.
19-
- remove_background: Remove the background of image_path -> { job_id }.
18+
- generate: Submit an image job (text->image or image->image). Returns { job_id }; poll with the status action. Params: provider, mode (text|image), prompt, image_path|image_url, model, transparent, width, height, name, output_folder.
19+
- remove_background: Unsupported in this version; returns an error instead of a job_id.
2020
- status: Poll an async job by job_id -> { state, progress, assetPath?, error? }.
2121
- cancel: Cancel an in-flight job by job_id.
2222
- list_providers: List configured image providers and capabilities (no key values).
@@ -29,7 +29,7 @@ ACTIONS:
2929
| `provider` | `str \| None` || Provider id (fal, openrouter). |
3030
| `mode` | `str \| None` || Generation mode: text or image. |
3131
| `prompt` | `str \| None` || Text prompt for text->image. |
32-
| `image_path` | `str \| None` || Path to a source image for image->image / remove_background. |
32+
| `image_path` | `str \| None` || Path to a source image for image->image mode. |
3333
| `image_url` | `str \| None` || URL of a source image for image->image. |
3434
| `model` | `str \| None` || Provider model id/slug (e.g. FLUX, gemini-2.5-flash-image). |
3535
| `transparent` | `bool \| None` || Mark the imported texture as alpha-is-transparency. NOTE: fal/FLUX and OpenRouter have no generation-time transparency, so this only sets the Unity import flag — it does not make the model render a transparent background. |

0 commit comments

Comments
 (0)