request_user_context
New Shoot Board
Use this when the user wants a photoshoot and you have no board_id yet. Creates a new, empty Uwear Shoot Board and returns its board_id, which every other Shoot Board tool takes. This client shows no widget: build the shoot with tools (search_uwear_library, modify_shoot_board, propose_brief) and tell the user what is on the board. prompt: one line describing the shoot; expected_types: what it needs.
输入参数prompt必填board_idmin_itemsexpected_types必填
read_shoot_board
Read Shoot Board
Use this before modify_shoot_board, propose_brief or update_brief: the user changes the board in the widget at any time. Returns the board's items (Clothing, Models, Outfits, Locations, art directions, files, results) with ids and names, its revision, its linked brief_id, and brief_inputs: the guide, asset facts, automations, cameras, AI models and limits a brief is written from. Changes nothing.
输入参数board_id必填
search_uwear_library
Search Library
Use this when the user names Clothing, Models, Locations, art directions, files or past results in chat and you need their ids. Takes a short keyword query (2-5 words, or an exact name, SKU or id) and returns typed ids, names and thumbnails. It finds items; it does not recommend them. Changes nothing.
输入参数limitquery必填item_typesrefresh_indexexclude_clothing_item_ids
modify_shoot_board
Change Shoot Board
Use this when the user asks in chat to change what is on the open Shoot Board. add puts items on it; set replaces the whole item list (to remove items, send the ones to keep); clear empties one type, or without type starts a new shoot on the same board (its brief is unlinked; photos stay in the library); add_as_view makes from_garment_id's photo the back, side or detail view of garment_id and takes from_garment_id off the board, only after the user agrees the two show one garment. Items are {type, id} from search_uwear_library or read_shoot_board. To reuse an automation, add {type: automations, id: a workflow_id from brief_inputs.automations}: the board pins one and the next brief runs every look through it. Pass expected_revision from read_shoot_board; on revision_conflict, apply the change to the returned board once.
输入参数typeviewitemsaction必填board_id必填garment_idfrom_garment_idexpected_revision必填
show_in_shoot_board
Show in Shoot Board
Moves a Shoot Board that is open in a widget to a view (board, brief, automation, results, brief_history). This client shows no widget, so it changes nothing the user sees: read the board, brief or results with read_shoot_board, get_brief or get_generation_results and tell the user.
输入参数view必填board_id必填look_key
add_chat_photos_to_board
Add Chat Photos to Board
Use this when the user attaches images in this chat and wants them in Uwear, on the Shoot Board or in a shoot: clothing, a Model, a Location or a reference. Put each attachment in its own field, image_file_1, image_file_2, ... in attachment order, as the chat provides it: ChatGPT passes the file itself, also when you see only a file name or path. Chat attachments only: a web address is refused (ask the user to attach that photo). kinds: {image_file_N: garment|avatar|location|reference} for photos whose kind the user said or is clear (avatar: a person to use as a Model); Uwear sorts the rest. Saves each photo to the library (a repeat is reused), adds it to the board and returns its pile and asset id for propose_brief / update_brief. A photo returned unsure lists two candidates: ask the user and call again with the same files, kinds and sides. sides: {image_file_N: back} for a garment photo that plainly shows the garment's back (you can see it); left out, a photo is its garment's front.
输入参数kindssidesboard_id必填image_file_1必填image_file_2image_file_3image_file_4image_file_5image_file_6image_file_7image_file_8image_file_9另有 2 个
set_garment_side
Set Garment Side
Use this when a garment's photo shows its back but Uwear has it as the front (or the other way round): you saw the photo in this chat, or the user says so. side back makes the photo the garment's back, so back shots run from it; front undoes that. Call it yourself and continue (confirm_brief if the user asked to run): never ask the user to relabel a photo on the board. The board's brief is saved again with its new quote. Deletes nothing.
输入参数side必填board_id必填garment_id必填
save_art_direction
Save Art Direction
Use this when the user asks to create, write or save an art direction, or the board's New art direction asks for one: write it from their words, the chat and the board, and save it in the same turn. Saves it to the library and makes it the board's one art direction, replacing the previous one (which stays in the library). Fill every section with concrete, photographable choices. It applies to every look, so it names no garment, outfit, Model or Location (text naming a board item is refused). If the board has a brief, apply it with update_brief direction.art_direction_id. If the result lists problems, fix them all and call again.
输入参数mood必填name必填avoidlight必填camera必填palette必填setting必填styling必填board_id必填overview必填must_keepvariations
propose_brief
Propose Brief
Saves a new brief and shows it on the board: the looks to shoot, their direction and their shots. The previous brief is kept (one that ran stays in Brief History). Returns the saved brief, or the problems to fix.
输入参数looks必填titlerecipeboard_id必填direction必填recipe_workflow_id
Use this when the user asks in chat to change the board's brief: its looks, Models, outfits, Locations, references, name, shots and steps, AI model or art direction. Send the complete replacement look list with the brief_id it replaces, keeping each unchanged look's key. Shots or steps: recipe with the complete new shot list (recipe_look_keys for some looks only) or recipe_workflow_id. AI model only: image_model / video_model. Art direction only: art_direction_id. Saves the revised brief on the board; nothing runs. If the result lists problems, fix them all and call again; on revision_conflict, read the board and revise its current brief.
输入参数looks必填titlerecipeboard_id必填brief_id必填directionimage_modelvideo_modelrecipe_look_keysrecipe_workflow_id
Use this when you need a Shoot Board brief by brief_id: its looks, automations, credit quote (quote.total_credits), status and revision. Shows it on the board; spends nothing.
输入参数board_id必填brief_id必填
confirm_brief
Generate Brief
Generates the photos and videos of brief brief_id. Spends credits at the brief's quote. This client may show no approval prompt, so call it only when the user agreed in chat to run the brief: their message asking to generate or run it is that agreement, a request to change the brief is not one; otherwise give the quote and wait for their yes. expected_brief_revision, runs and expected_total_credits must match the latest brief; if they changed, nothing runs and the current brief is returned. The same idempotency_key never runs or charges twice.
输入参数runs必填board_id必填brief_id必填idempotency_key必填expected_total_credits必填expected_brief_revision必填
Use this to find a past shoot when the user refers to one ("run the same as last week") or asks what ran: the account's briefs, newest first, 10 by default (limit up to 25; before: next_before for older ones; status ran for generated ones only; automation_workflow_id for the runs of one Automation). Each compact row has its brief_id, title, status, ran_at, automations, direction label, image model, output, look count and credits. Then read the one you need with get_brief for its full values. Changes nothing.
输入参数limitbeforestatusboard_id必填automation_workflow_id
list_automations
Automations
Lists the user's Automations, most recently used first, one row each. 10 per page (limit up to 25; cursor: next_cursor for more). Changes nothing.
输入参数limitcursorboard_id必填
mcp_brief_runs
Follow Brief Runs
Use this after confirm_brief or when the user asks how a shoot is going: each look's run of brief_id with its status, credits, results (generation_result_id, kind, url) by step and the error of every step that failed (failures lists them all). Read it again until done is true; while it runs, say so (the board shows progress). Then show the results with get_generation_results. Changes nothing.
输入参数board_id必填brief_idworkflow_run_ids
get_generation_status
Generation Status
Use this to check one generation job by generation_id: its status, credits and, when it failed, a safe error_message. A brief's runs are read with mcp_brief_runs. Changes nothing.
输入参数generation_id必填include_snapshot
get_generation_results
Show Results
Use this to show results in chat: generation_result_id (from mcp_brief_runs) for one result, generation_id for a job's results, or query, filters and dates to find past ones. Returns image previews to show as they are (never Markdown-embed result URLs); url is the original. Changes nothing.
输入参数kindpagelimitquerytag_idsdecisionend_datemodel_idsavatar_idsoutfit_idsstart_dateqa_statuses另有 7 个
list_garments
List Garments
List user's garments with structured filters or query for hybrid name/SKU/metadata/image-attribute search. body_zone expands to categories and is ORed with category when both are given. With a category or body_zone filter and include_uncategorized=false, uncategorized_count reports garments hidden by the category filter within the same scope. If matches are short and uncategorized_count > 0, call again with include_uncategorized=true and inspect those garments.
输入参数pagesortlimitquerytag_idscategoryend_datebody_zonestart_dateclothing_item_idsinclude_image_urlinclude_uncategorized另有 1 个
upload_garment_from_public_url
Upload Clothing from URL
Upload Clothing from public HTTP(S) image URLs. Queues a recoverable batch upload and returns an operation immediately; retry with the exact same arguments to read its state (a retry creates no second upload). Photos are stored as uploaded, without background removal; processing_mode is ignored. Prefer assets with {asset_kind: full|detail, asset_view: front|back|side, asset_url}; exactly one full front is required, every full view is unique, and detail views can repeat. No base64, chat file objects, or local paths.
输入参数nameassetsgenderboard_idgarmentsfile_nameimage_urlmime_typedescriptionback_image_urlside_image_urlprocessing_mode另有 1 个
List the user's Models: the reusable people who wear the Clothing (not the AI models; for those, use mcp_list_model_catalog). Supports structured filters or query for hybrid name/metadata/image-attribute search. Set include_image_url=true when the Model's image itself is needed.
输入参数pagesortlimitquerytag_idsend_dateavatar_idsstart_dateinclude_image_url
upload_avatar_from_chat_file
Upload Models from Chat
Batch upload reusable Models from person photos the user attached in chat. Each photo becomes the upper_body_front identity anchor. Keep names and optional user-given age_range, build, and height_cm in avatars[], then pass top-level image_file_1, image_file_2, etc. in the same order. Traits are never guessed. No base64, no local paths. Do not use ordinary text-to-image results as an upload fallback. Use only when the user explicitly wants a specific or consistent person.
输入参数namebuildavatarsboard_idage_rangefile_nameheight_cmimage_urlmime_typedescriptionimage_file_1image_file_2另有 8 个
List user's outfits (saved garment combinations). Filter by garment IDs, active status, date range, or query against contained garments.
输入参数pagesortlimitquerysourcetag_idsend_dateis_activeoutfit_idsstart_dateclothing_item_ids
list_locations
List Locations
List reusable location/scene reference images by structured filters or query: IDs, tags, date range, and sort. Use when the user wants to pick a saved background/location reference for a generation.
输入参数pagesortlimitquerytag_idsend_datestart_datelocation_idsinclude_image_url
create_location
Create Location
Create a reusable location/scene reference from an image URL. If no description is supplied, the backend analyzes the image. Use the returned location_id in propose_brief/update_brief.
输入参数name必填tag_idsimage_url必填descriptionthumbnail_urlsource_metadata
Create a new tag for organizing assets (garments, models, outfits, files, results, locations). Requires an active company workspace.
输入参数name必填color
queue_generation_result_qa
Run QA on Results
Default tool for generation-result QA. Use this whenever the user asks to QA, quality check, validate, review, inspect for defects, approve/reject, or assess already-created generation results. Do not substitute view_image for QA unless the user explicitly asks for a manual visual critique instead of the official Uwear QA pipeline. First identify the numeric generation_result_ids, then call this tool, then call read_generation_result_qa for the same IDs. QA is free. QA is built for scale — validating large batches (hundreds or thousands of results). When the user is iterating on a handful of results one by one, do not queue QA on your own initiative; run it when the user asks for it or when operating at batch scale.
输入参数max_qa_retriesgeneration_result_ids必填
read_generation_result_qa
Read QA Results
Read official Uwear QA status, decision, and structured QA JSON for existing generation results. Call this after queue_generation_result_qa when the user asks to QA/check/validate/review generated outputs; summarize the structured decision and issues, not a manual view_image opinion.
输入参数generation_result_ids必填
set_generation_result_favorite
Favorite Result
The result viewer's star. Marks one of the user's own generation results as a favorite (favorite true) or removes the mark (false); deletes nothing and spends no credits.
输入参数is_favorite必填generation_result_id必填
propose_montage
Create Video Montage
ONLY for video montage/stitching/export workflows. Use when the user explicitly asks to create a montage, stitch clips, make a reel, export a video sequence, make video clips from images, or combine images/videos into one final video. Never use this for a photoshoot, lookbook, product shoot, collection shoot, outfit shoot, garment shoot, or image-generation request; those must use request_user_context followed by propose_brief/update_brief. Do not call this merely because selected context contains images, generations, garments, or models. A photoshoot may later feed a montage, but the photoshoot itself must be proposed as a BriefProposal first. PROPOSES the montage for user review — user can edit clips, generate missing videos, then export. Supports: existing videos with optional trim (`target_duration` or `start_time`/`end_time`), images that need video generation (specify video_model + a bespoke per-image motion prompt, and optionally `target_duration` or `duration`), per-clip speed/mute, global aspect ratio. If the user asks for clips to be e.g. '3 seconds each', set `target_duration: 3` on every item, including image items. For image items, avoid generic repeated prompts: tailor each prompt to the specific image and any requested zoom, movement, energy, or camera direction. If motion is not specified, inspect the image first with view_image and then write a fitting motion prompt from the image content before proposing. The user reviews and confirms in the UI. Export is free (0 credits); video generation clips cost credits per their model.
输入参数items必填board_idaspect_ratiobase_resolution
update_montage_proposal
Update Video Montage
Patch the latest MontageProposal already shown in the UI. Use only for an existing video montage/reel/stitched sequence proposal; do not use this to modify a photoshoot brief. For photoshoot brief changes, call update_brief instead. Prefer `operations`, an ordered list of typed montage edits such as `clear_trim`, `remove`, `set_duration`, `set_trim_range`, `set_speed`, `set_muted`, `set_prompt`, `set_video_model`, `set_generate_audio`, `set_last_frame`, `set_aspect_ratio`, and `set_base_resolution`. Use `set_trim_range` for requests like 'use the second half', 'start at 3s', or 'trim from 3s to 6s'. Operations are applied in order to the current montage state. Legacy flat fields are still accepted as a compatibility shim. This updates the proposal only; it does not execute export or generation.
输入参数mutedspeedpromptremoveboard_idend_timeclear_trimoperationsstart_timeclip_numbervideo_modelapply_to_all另有 6 个
get_user_credits
Get Credit Balance
Get user's current credit balance.
无需输入参数。
List available tags for the user's company. Use this to resolve user-provided tag names like 'summer26' before selecting garments, outfits, models, files, generations, or locations. For no-UI MCP flows, find the tag ID here, then call get_items_by_tag or the relevant list_* tool with tag_ids.
无需输入参数。
save_reference_file_from_chat_file
Save Reference Images
Batch save reference images from chat attachments into the Files library. Keep file metadata in files[] and pass top-level image_file_1, image_file_2, etc. in the same order. No base64, no local paths. Use for mood boards, backgrounds, and other reference images that are not Clothing or Models.
输入参数filesboard_idfile_nameimage_urlmime_typeimage_file_1image_file_2image_file_3image_file_4image_file_5image_file_6image_file_7另有 3 个
list_art_directions
List Art Directions
List selectable ArtDirections as compact summaries: visible system ArtDirections plus company ArtDirections. Use query to match exact names and natural-language creative requests. Use this as the catalog step before choosing an art_direction_id for a brief; if there is no clear match, fall back to the user's phrase as prompt/creative_context. Use get_art_direction for the full markdown document before reusing one in a brief.
输入参数pagelimitquery
get_art_direction
Get Art Direction
Get a selectable ArtDirection by ID.
输入参数art_direction_id必填
list_templates
List Templates
List canonical company templates, optionally filtered by kind, scope, command use case, or public t-xxxx share code. Templates persist canonical commands but do not execute generations. System templates named `Demo — …` are worked examples of the canonical command language; read one with `get_template` before authoring a first brief or workflow.
输入参数pageuse_caseshare_codecatalog_scopetemplate_kinditems_per_page
mcp_get_context
Get Shoot Board
Read the Uwear Shoot Board.
输入参数board_id必填board_version
mcp_replace_context
Replace Shoot Board
Replace the Uwear Shoot Board items.
输入参数board_id必填board_versioncontext_itemscontext_stateexpected_revision必填
mcp_add_context
Add to Shoot Board
Append items to the Uwear Shoot Board.
输入参数board_id必填board_versioncontext_items必填expected_revision必填
mcp_clear_context
Clear Shoot Board
Clear all Shoot Board items, or only one context type.
输入参数typeboard_id必填board_versionexpected_revision必填
List uploaded (reference) files for the Uwear MCP workspace files tab and the Shoot Board's References tab.
输入参数pagelimitquerytag_ids
mcp_save_retouch
Save Retouched Image
Save an edited image (image_base64) as a new child result of parent_generation_result_id. Changes no existing result.
输入参数file_namemime_typeoperationsimage_base64必填parent_generation_result_id必填
mcp_export_montage
Export Montage Video
Export montage clips as one stitched video. Spends credits: call it only after the user confirmed the clips and their order in chat. Returns the generation_id to poll with get_generation_status.
输入参数clips必填fit_mode必填aspect_ratio必填base_resolution必填
mcp_generate_clip
Generate Montage Clip
Queue an image-to-video generation for one montage clip. Spends credits: call it only after the user agreed in chat. Returns the generation_id to poll with get_generation_status.
输入参数model必填promptdurationimage_urlresolutiongenerate_audiolast_frame_urluploaded_file_idgeneration_result_id
mcp_intake_files
Sort Dropped Photos
Sort photos dropped on the Shoot Board into garment, avatar, location or reference (or unsure with two candidates) and report duplicates within the drop and in the library. Saves nothing. A photo the call had no time left for comes back with error deferred: send it again.
输入参数files必填board_id
mcp_commit_intake
Save Dropped Photos
Save sorted Shoot Board photos to the library as garments, avatars, locations or reference files, skip ones already saved, and add them to the Shoot Board at expected_revision; a board that changed is refused before anything is saved (revision_conflict with the current board).
输入参数items必填board_id必填expected_revision必填
mcp_reclassify_board_item
Move Photo to Another Pile
Move a Shoot Board photo between the Clothing, Models and Locations piles. Saves the same image as the new kind and swaps it on the board; the old asset is deleted only if intake saved it in the last 24 hours and nothing uses it, otherwise it stays in the library. Asking for a move that already happened changes nothing and returns the board (status "unchanged").
输入参数to必填item必填board_id必填expected_revision必填
mcp_add_garment_view
Add Garment View
A Clothing card dropped on another. The photo of from_garment_id becomes the back, side or detail view of garment_id, and from_garment_id leaves the board (deleted only when it is a fresh drop nothing else uses). Or a photo put in the brief's missing-photo slot: image_url instead of from_garment_id, nothing leaves the board. The board's draft brief is saved again when the view changes it. Returns the board (and brief); asking again answers status unchanged.
输入参数view必填board_id必填image_urlgarment_id必填from_garment_idexpected_revision必填
mcp_upload_intake_photo
Upload Dropped Photo
Store one photo dropped on the Shoot Board, sent inline as base64, for a host that cannot upload files itself. Returns a receipt (sha256, size, stored, image_url, image_url_expires_at); pass image_url to mcp_intake_files and mcp_commit_intake. Without data, stores nothing and returns the receipt of the photo already stored under sha256 (a fresh image_url), or stored: false.
输入参数datasha256必填content_type
mcp_edit_brief
Edit Board Brief
Edit the Shoot Board's brief by hand: add, remove or change looks, or run looks through another automation. Saves a new brief linked to the board and returns the board, the brief, its quote and the credit delta; dry_run only quotes.
输入参数ops必填dry_runboard_id必填brief_id必填expected_brief_revision必填
mcp_recipe_history
Automation History
An automation's past runs, newest first: one row per Shoot Board Generate (its looks) or per run started on Uwear, with when, how it went, credits and covers.
输入参数pageboard_id必填workflow_id必填
The account's Shoot Board briefs, newest first: every brief that ran (on any Shoot Board) and this board's draft, each with its status, looks, automations, credits and covers.
输入参数pageboard_id必填
mcp_recipe_list
List Automations
The company's shoot automations (and other automations to copy).
输入参数pagequeryboard_id必填items_per_pageinclude_automationsinclude_definitions
mcp_recipe_open
Open Automation
Open the brief's automation in the builder: its draft, or once Generate published it its live version (saving an edit of it makes a new automation); another automation opens read-only.
输入参数board_id必填read_onlyversion_idworkflow_id必填
mcp_recipe_preflight
Check Automation
Validate and price the automation being edited.
输入参数graph必填board_id必填version_id必填workflow_id必填
mcp_recipe_save_draft
Save Automation Draft
Save the automation's draft.
输入参数edges必填nodes必填board_id必填version_idworkflow_id必填failure_policybase_version_idcontract_versionresult_projectionexpected_definition_hash
mcp_recipe_copy
Copy as New Automation
Copy an automation as a new automation for this shoot.
输入参数nameboard_id必填source_version_idsource_workflow_id必填
mcp_workflow_assets
Workflow Assets
The automation builder reads library items (Clothing, Models, Locations, ...) of one kind by id to show them on its cards. Read-only.
输入参数ids必填kind必填board_id必填
mcp_workflow_gallery
Workflow Gallery
The automation builder's picker: one page of the user's library items of one kind, filtered by search text, tags or category. Read-only.
输入参数kind必填pagequerytag_idsboard_id必填page_sizecategories
mcp_workflow_tags
Workflow Tags
The account's tags, for the automation builder's tag filters. Read-only.
输入参数board_id必填
mcp_workflow_garment_categories
Garment Categories
The garment categories, for the automation builder's category filters. Read-only.
输入参数board_id必填
mcp_workflow_cameras
Cameras
The camera views (front, side, back, crops) a shot or camera edit can use, for the automation builder. Read-only.
输入参数board_id必填
mcp_workflow_contract
Workflow Contract
The automation format (step kinds and their settings) the automation builder edits against. Read-only.
输入参数board_id必填contract_version
mcp_read_generation_result
Read Result
One generation result as GET /generation-result/{id} returns it (tags, review verdict, QA, prompt, model), for the widget's result viewer.
输入参数generation_result_id必填
mcp_read_generation
Read Generation
One generation with its results as GET /generation/{id} returns it (prompt, model, settings, inputs), for the result viewer's Info panel.
输入参数generation_id必填
mcp_review_generation_results
Review Results
The result viewer's review rail. Sets the user's verdict on their own results to approved or rejected, or clears it (decision null), replacing any verdict they had; deletes nothing and spends no credits.
输入参数notedecision必填generation_result_ids必填
mcp_set_generation_result_tags
Set Result Tags
Replace a result's tags with tag_ids (empty removes all), as PUT /generation-result/{id}/tags. The result viewer's tag tray. A tag that starts one of the user's automations starts it, as on the platform.
输入参数tag_ids必填generation_result_id必填
Rename or recolor one of the company's tags, as PATCH /tag/{id}. The result viewer's tag tray.
输入参数namecolortag_id必填
mcp_delete_generation_results
Delete Results
Delete the user's results and their stored images, as the platform's Delete. Cannot be undone: call it only after the user confirmed in chat which results to delete.
输入参数generation_result_ids必填
mcp_list_model_catalog
List Model Catalog
The active AI models with their capabilities and pricing rules, as GET /models returns them, for the widget's model pickers.
无需输入参数。
uwear_settings_read
Read Photoshoot Settings
Read the user's saved photoshoot defaults (aspect ratio, camera, resolution) with every allowed value. Backs the plugin settings page.
无需输入参数。
uwear_settings_update
Update Photoshoot Settings
Save changed photoshoot defaults (aspect ratio, camera, resolution). Send only the settings that changed; returns every current value. Defaults never authorize a paid generation.
输入参数set必填