GlossiDocs
Start free
Agents (MCP)

Agent tool reference

Every tool the Glossi MCP server offers an agent, grouped by area, with what it does and whether it reads, changes or deletes.

Every tool your agent can call once it is connected to Glossi. Your agent reads the full description and arguments of each tool when it connects, so you never call these yourself. This page is for knowing what to ask for and what the agent will ask you before doing.

Enterprise. Agent access is available on Enterprise. It uses the same plan gate as REST API keys.

Kind comes from the tool's own annotations:

  • read only fetches data, or shows an in-chat panel.
  • write creates or changes something in your workspace.
  • destructive deletes, replaces or overwrites something. The agent names what will go and asks you before it calls one.

Every tool takes an optional workspaceId. Leave it out and the agent works in your default workspace, and says so. Tools that spend usage say so below; the agent confirms before large batches, and get_usage reports what is left as a percentage.

Workspace and projects

ToolKindWhat it does
list_workspacesreadWorkspaces you can work in, and which is the default.
get_usagereadHow much of this month's usage is left, as a percentage, and when it renews.
list_projectsreadProjects in the workspace, newest first.
create_projectwriteBuild a project from existing models, optionally with a template's scene setup. Projects an agent creates are marked with an agent source in the app.
rename_projectwriteGive a project a new name.
delete_projectdestructiveDelete a project. Its renders stay. Refused while a template made from it exists or a Studio has it open.
list_templatesreadSaved scene setups (lighting, backdrop, cameras), yours and Glossi's public ones.
save_project_as_templatewriteSave a project's scene as a new template, so other models can be built into the same setup. Not available on the legacy Starter plan.
update_template_from_projectwriteSave a new version of a template from a project. Earlier versions are kept.
apply_template_to_projectdestructiveReplace a project's scene with a template's. The models stay; the old scene doesn't. Refused while the project is open in a Studio, where studio_apply_template does it in place.

Getting files in

The upload panels only exist in Claude.ai and Claude Desktop. In a client with a shell, the agent uploads from disk with the create_* and confirm_* tools instead. Models and props can be up to 3 GB; anything Glossi fetches from a link can be up to 1 GB.

ToolKindWhat it does
upload_modelreadShows an in-chat upload panel for one model, many, or a whole folder.
upload_props, upload_decalsreadThe same panel for props (3D files) or decals (images).
upload_materialsreadThe same panel for a folder of PBR textures, loose or zipped, with a review step before upload.
import_modelwriteAdd a model from a public download link. Glossi fetches it server-side.
create_model_uploadwriteStart an upload from disk: returns a modelId and a URL to PUT the file to.
confirm_model_uploadwriteTell Glossi the file is uploaded; processing starts.
start_model_multipart_uploadwriteSplit a large upload into parts that resume if interrupted.
get_model_upload_part_urlsreadUpload URLs for parts of a multipart upload.
complete_model_multipart_uploadwriteAssemble the uploaded parts; processing starts.
abort_model_multipart_uploaddestructiveDiscard the parts uploaded so far.
wait_for_modelsreadWait until models are READY or APPROVED, or have failed.
create_library_uploadswriteStart a batch upload: 3D files as models or props, images as decals, PNG or JPEG backgrounds as backplates.
confirm_library_uploadswriteConfirm the batch is uploaded; models and props start converting.
wait_for_propsreadWait until props finish converting.
plan_material_importreadGroup a folder's texture images into PBR materials by file name.
create_material_uploadwriteStart one PBR material from its texture files.
confirm_material_uploadwriteConfirm the textures are uploaded. Optionally generate missing maps (spends usage; the agent asks you the material type and whether it has transparency first) or upscale the base colour.

Library

ToolKindWhat it does
list_modelsread3D models in the library, newest first. Only READY or APPROVED models can be placed.
get_model_downloadreadA one-hour link to a model's converted GLB, its USDZ, or the original file.
get_model_uv_metricsreadHow well each part is UV-mapped: texel density, stretch, and spread across parts.
list_library_foldersreadThe folders for models, materials, decals or backplates.
update_library_itemwriteRename a model, prop, decal, material or backplate, or move it into a folder.
delete_library_itemsdestructivePermanently delete up to 50 items of one kind. Models still placed in projects are skipped unless you say otherwise.

Materials

ToolKindWhat it does
search_materialsreadFind materials by name, colour or category, in your workspace or the Glossi catalog.
find_materialreadFind a described material ("purple suede") in your library, the Glossi catalog, then Poly Haven and ambientCG. Says whether to use one as it is, add one, or generate one.
add_materialwriteAdd a material to your library: a catalog material, a recoloured library or catalog material, or an imported online scan. Doesn't spend usage.
generate_materialwriteCreate a PBR material from a description, a reference photo, or both. Spends usage.
upload_material_referencereadShows an in-chat upload panel for one photo of a surface, to generate a material from.
create_material_reference_uploadwriteUpload URL for a local reference photo, for generate_material or sample_photo_colors.
sample_photo_colorsreadMeasure the colour of each zone of a reference photo, so find_material matches it exactly.
recolor_materialwriteAdd a material that keeps another's textures and finish, tinted a new colour. The source is a library material or a fabric region on a model. Best on a near-white fabric.
wait_for_materialsreadWait until materials are ready.
swap_materialwriteReplace materials on models by slot name, producing new model variants.
get_material_swap_statusreadProgress of a swap batch and the variants it produced.
list_design_materialsreadDesign materials: SVG designs whose colour slots a variant can recolour.
list_workspace_colorsreadThe workspace colour library, with hex, CMYK and Pantone, for a design's slots.

Models from photos

ToolKindWhat it does
get_model_generation_offerreadWhether the workspace can create models from photos, and how they are paid.
generate_model_from_photoswriteStart a 3D model from 1 to 6 product photos. Spends usage when it starts, unless your workspace has models included or priced per model, in which case a model is paid when you approve it.
wait_for_model_generationreadProgress of a generation; when ready, preview views to review; once added, the modelId.
list_model_generationsreadYour generations, newest first.
approve_generated_modelwriteAdd a reviewed model to the library. Pays for it when your workspace buys models per model.
decline_generated_modeldestructiveThrow a reviewed model away. Usage it spent is kept.

Model prep

See Model prep API for arguments and the matching REST endpoints.

ToolKindWhat it does
get_model_prep_offerreadWhat a full prep of the model costs, the changes included, and whether it is paid at the start or on keep.
prepare_modelwriteSplit a model into parts, name its parts and finishes, redo its UVs. Label, UV and material passes spend usage. A full prep (splitting into parts) is a one-off purchase charged to the workspace's saved card; the agent tells you the price and asks first.
match_variant_to_photowriteMake a variant that looks like photos of the product: regroups the parts by the colour zones in the photos and picks a library material for each. Spends usage.
get_model_prepreadProgress of a run; when ready, what changed and what the prep wasn't sure of.
list_model_prepsreadA model's runs, newest first.
retry_model_prepwriteChange one area of a result from your feedback and screenshots. May ask a question first. A change to a usage run spends usage.
keep_model_prepwriteMake the result the model's current version. Pays for a full prep that wasn't paid when it started.
discard_model_prepdestructiveThrow the result away.

Renders and edits

ToolKindWhat it does
renderwriteRender one or more projects: every shot, clip and variant unless narrowed. Spends usage.
get_render_statusreadStatus of one render job; when complete, a link per image or video.
wait_for_renderreadWait for every job in a render batch to finish.
get_render_imagereadA finished render as an inline preview plus a one-hour full-resolution link.
list_rendersreadSearch finished renders by project, name, date, video or favourites.
edit_renderwriteChange the scene around the product in a finished image, from a prompt, a brand style, or both. Saved as a new edit; the original stays. Spends usage.
wait_for_render_editreadWait for an edit to finish, then a one-hour link to the image.
list_brand_stylesreadYour brand styles, for edit_render.
upload_brand_style_referencesreadShows an in-chat upload panel for up to 10 reference images for a new brand style.
create_brand_style_reference_uploadwriteUpload URL for one local reference image.
create_brand_stylewriteCreate a brand style from 1 to 10 reference images and an optional standing direction.
wait_for_brand_stylereadWait until a new brand style has read its images, then a summary of the look.

Sharing

ToolKindWhat it does
share_modelwriteA public link to view a model, plus an embed for a web page. Asks before making a private model public.
list_model_share_linksreadA model's live links, with view counts.
revoke_model_share_linkdestructiveStop a link working; pages embedding it stop showing the model.

Variants and logos

See Variants and logos for arguments and the matching REST endpoints.

ToolKindWhat it does
list_model_variantsreadA model's variants and its material slots, newest first.
create_model_variantwriteDefine a variant from material assignments, or copy another variant's materials and logos.
request_variant_previewwriteBuild a variant's 3D preview again: after a failure, or for a variant made before previews were automatic.
add_variants_to_projectwriteAdd variants to the list a project works with. The first add narrows the project to that list.
get_project_variant_choicesreadWhich variant each model in a project wears.
set_project_variant_choicewriteChoose the variant one model wears in one project, or clear the choice.
get_decal_slotsreadA model's decal slots, their printed size, and which logo each variant has in each slot.
set_decal_assignmentwritePut a library logo in one slot for one variant, or clear the slot.
set_decal_logo_sizewriteSize the logo one variant wears in one slot, in centimetres, or reset it to fit the slot.

Properties

See Properties and asset search for examples.

ToolKindWhat it does
list_properties, get_propertyreadThe workspace's property definitions and their option ids.
create_propertywriteAdd a property: select, multi-select, text, number or date. Its type can't change later.
update_propertydestructiveRename a property, change which assets it applies to or how it shows on cards, or archive or restore it.
archive_propertydestructiveArchive a property, or restore it. Values on assets are kept; there is no permanent delete.
reorder_propertiesdestructiveChange the order properties show in.
add_property_optionwriteAdd an option to a select property.
update_property_optiondestructiveRename, recolour, reorder, archive or restore an option.
merge_property_optionsdestructiveReplace one option with another on every asset, then remove the first.
convert_tag_to_property_optionwriteTurn a tag into a property option on the models that carry it. The tag stays.
get_asset_propertiesreadThe property values on one asset.
set_asset_propertiesdestructiveSet or clear values on up to 100 assets of one type.
search_assets_by_propertiesreadFind assets of any supported type by property values.

Creating and changing definitions and options needs the workspace owner or admin role. Setting values on assets doesn't.

Automations

Enterprise. Automations are available on Enterprise. Only one automation can be active in a workspace at a time.

A new automation is saved paused. Your agent can't sign in to Google Drive, OneDrive or AEM for you, and credentials never pass through it: a step that needs one of those accounts is saved unconnected, and the agent gives you a link to connect it in Glossi. The matching REST endpoints are under /api/v1/pipelines.

ToolKindWhat it does
list_automationsreadYour automations, their trigger, the steps they run and whether they're ready.
get_automation_optionsreadEvery trigger and step, which can follow which, and the connectors.
get_automationreadOne automation's steps and settings, and anything left to set up in Glossi. Credentials are never shown.
create_automationwriteBuild an automation, saved paused. An invalid chain is refused with what's wrong.
update_automationdestructiveChange the name, steps or settings, or activate or pause it. Changing an active automation's steps needs your yes; activating one lets it spend usage unattended and pauses your other active automation.
delete_automationdestructiveDelete an automation and its job history. What it made is kept unless you ask. Refused while jobs are running.
run_automationwriteRun an automation now, like Run once. A Manual automation can run on models you choose. Pauses your other active automation while it runs. Spends usage.
get_automation_runreadProgress of a run: each model's steps, renders, outputs and errors.
wait_for_automation_runreadWait for a run to finish.

Pantones and logo inks

ToolKindWhat it does
set_decal_inkswriteReplace a library logo's ink list, from a list or a spec line such as "2 color / white / red pms 200c".
create_pantone_materialwriteAdd a flat-colour library material that renders as a Pantone.
set_material_pantonewriteRecord or clear the Pantone on any library material. Its look does not change.

Names, numbers and logos placed at named locations on a model's print space.

ToolKindWhat it does
get_element_locationsreadWhere elements can sit on a model: its print space and named locations, with default offsets, heights and ranges.
set_element_locationsdestructiveReplace a model's whole location set, or remove it.
validate_elementsreadCheck elements against a model's locations and the workspace colour library before ordering.
render_elementsreadDraw elements on a model's print space and return a one-hour link to a PNG, a true-size PDF, or an SVG.
get_variant_elementsreadThe elements a variant wears, with links to its rendered layer.
set_variant_elementswritePut elements on a variant, or remove them. They are validated and rendered into the variant's print layer.
list_element_templatesreadThe workspace's element templates (recommended layouts), optionally only those that fit one model.
save_element_templatewriteCreate an element template, or replace the one with the same name.
apply_element_templatereadA template's elements laid onto one model, ready to fill in and validate. Changes nothing.
delete_element_templatedestructiveDelete an element template. Elements already placed from it stay.
list_fontsreadThe workspace font library for print elements.
create_font_uploadswriteStart uploading TTF, OTF or WOFF fonts.
confirm_font_uploadswriteCheck uploaded fonts; each becomes READY or FAILED with a reason.
rename_fontwriteChange a font's display name.
delete_fontdestructivePermanently delete a font. Elements that use it stop validating until they pick another.

Studio sessions

These tools find the Studio to work on, collect results, and save or render it. See Control the Studio from an agent for how live and cloud sessions work.

ToolKindWhat it does
list_studio_sessionsreadYour open Studio sessions in the workspace, live or in the cloud, and the project each has loaded.
get_studio_selectionreadWhat you have selected in the Studio: photo or video mode, the current shot or clip, and what the right panel shows.
open_studio_sessionwriteLoad a project into a Studio in the cloud, with nobody watching. Takes 5 to 15 minutes to start and uses Studio time while it runs. One per workspace.
wait_for_studio_sessionreadWait for a cloud session to reach its next stage, until it is READY or FAILED.
close_studio_sessionwriteSave the project and end a cloud session.
save_studio_sessionwriteSave the project as the Studio has it now.
render_studio_sessionwriteSave, then render the shots, clips and variants as the Studio has them now, or only the ones named. Spends usage.
studio_promptwriteHand one instruction to the Studio's own Assistant, which plans and makes the change. Spends usage like a prompt in the Studio panel.
studio_batchdestructiveUp to 25 studio_ calls in one request, run in order. Marked destructive because a batch can include deletes; one that does is refused until you have said yes.
wait_for_studio_callreadCollect one change that was still running, or was sent without waiting.
wait_for_studio_callsreadCollect up to 50 changes sent without waiting.
list_studio_call_groupreadThe changes in one group, in order, with each one's status and timing.
list_studio_historyreadRecent groups of changes, newest first: label, who made them (you, the Assistant or an agent), when, and what they touched.
undo_studio_groupwriteRevert one earlier change by an agent or the Assistant. Refused when a later change touched the same part of the scene.
upload_studio_referencereadShows an in-chat upload panel for one photo for the Studio to match, such as lighting to copy.
create_studio_reference_upload, confirm_studio_reference_uploadwriteUpload URL for a local photo for the Studio to match, and the check that returns the key to use.

Studio scene

Every tool below starts with studio_ and acts on a Studio session: the one you have open, or a cloud session. Each takes an optional sessionId, plus wait, group and label (see How changes run).

Look at the scene

ToolKindWhat it does
studio_describe_scenereadEvery prop and product copy with its id, position, size and footprint in centimetres, plus the camera.
studio_capture_viewportreadA picture of the viewport as it is now.
studio_list_components, studio_get_hierarchyreadThe components on an object, flat or as a tree.
studio_find_by_name_pattern, studio_find_by_tagreadFind components by wildcard name or by tag.
studio_get_transform, studio_get_component_boundsreadA component's position, rotation and scale, or its bounding box.
studio_move_objectswriteMove, turn, scale or ground props and product copies, all moves in one call. With a shot selected, moving a product changes it in that shot only.

Props

ToolKindWhat it does
studio_search_prop_catalogreadSearch the prop catalog by plain words.
studio_place_propswriteAdd catalog props around the product from where you want them, never coordinates.
studio_remove_propsdestructiveRemove props from the scene. Undo doesn't bring them back.
studio_get_prop_materialsreadThe parts of one prop and what each can be changed to.
studio_set_prop_materialwriteChange one part of one prop: colour, finish, tiling, or the library material on it.
studio_list_prop_layoutsreadThe workspace's saved prop layouts.
studio_save_prop_layoutwriteSave the project's props as a layout any project can use.
studio_apply_prop_layoutdestructiveReplace the project's props with a saved layout.
studio_delete_prop_layoutdestructiveDelete a saved layout from the workspace. Props already in projects stay.

Camera and shots

Tool names say bookmark for a shot.

ToolKindWhat it does
studio_move_camerawriteOrbit, raise, pull back, or frame the product or a part. Only the live view changes until it is saved into a shot.
studio_list_bookmarksreadSaved shots with their aim, lens and exposure.
studio_add_bookmark, studio_edit_bookmark, studio_select_bookmarkwriteAdd, edit and select saved shots, or go back to the free camera.
studio_delete_bookmarkdestructiveDelete a saved shot.
studio_list_camera_targetsreadThe product's camera targets and which shots and clips aim at each.
studio_set_bookmark_product_visibilitywriteLeave a product out of one shot, or show it again.
studio_set_aspect_ratiowriteChange the frame's shape, such as 1:1, 9:16 or 16:9, for the whole project.

Clips

ToolKindWhat it does
studio_list_clips, studio_get_clipreadThe clips in the timeline, and one clip's framing and lens.
studio_add_clip, studio_edit_clipwriteAdd and edit video clips.
studio_delete_clipdestructiveDelete a clip.
studio_link_clip_to_bookmarkwriteStart a clip from a saved shot, or unlink it. Undo doesn't reverse it.
studio_set_clip_product_visibilitywriteLeave a product out of one clip, or show it again.
studio_preview_clipreadA clip's motion as 3 to 24 evenly spaced frames (4 by default), or at exact times. The clip is scrubbed, not played, and the Studio goes back as it was.
studio_animate_camerawriteGenerate a camera move for a clip from a description. Spends usage.
studio_animate_productwriteGenerate product motion for a clip, such as an exploded view or a spin. Spends usage.
studio_append_product_animationwriteAdd one generated motion on top of a clip's existing product motion. Spends usage.
studio_animate_lightswriteSwing, fade or push the whole light setup over a clip.
studio_get_clip_animation, studio_set_clip_animationread, writeRead a clip's camera or product keyframes, or write them directly without generating.
studio_set_animation_intensitywriteTurn a clip's generated animation up or down without generating it again. Undo doesn't reverse it.

Product

ToolKindWhat it does
studio_get_product_statereadEvery product copy, its variants and which is active, and its material groups.
studio_resolve_partreadTurn a part named in plain words ("the strap") into the material groups it wears.
studio_list_product_components, studio_get_part_islandsreadThe product's own parts, and its geometry split into separate pieces.
studio_add_productwriteAdd a model from your library to the scene.
studio_remove_productdestructiveRemove a product you added. The project's main product stays.
studio_select_product_variantwriteSwitch the product to one of its variants.
studio_add_product_variantwriteSave the product's current look as a new variant.
studio_rename_product_variantwriteRename a variant.
studio_delete_product_variantdestructiveDelete a variant, from the Studio and the library. The original can't be deleted.
studio_search_material_libraryreadSearch your material library and the Glossi catalog by plain words.
studio_list_material_paramsreadEvery value a part's material can take, with its range.
studio_set_material_groupwriteChange one part: colour, finish, tiling, or the library material on it.
studio_set_material_surfacewriteChange what kind of surface a part is, and its coverage.
studio_set_top_layerwriteStack a second library material over a part, such as dust or edge wear.
studio_set_material_furwriteTurn fur on or off on a fur part, pick its preset and tune it. Undo doesn't reverse it.
studio_set_component_visibilitywriteShow or hide one of the product's parts.
studio_define_moving_partwriteGive a part its own hinge or spin pivot so it can be animated.
studio_set_product_calibrationwriteTurn or reposition the model itself, for every project that uses it.
studio_save_material_to_librarywriteSave what a part is wearing now to the material library as a new material.
studio_update_library_material_from_partdestructiveOverwrite the library material a part wears with the part's current look. Every model using it changes.

Decals

ToolKindWhat it does
studio_search_decal_libraryreadSearch your decal library by plain words.
studio_list_decalsreadThe decals on the product, with where each sits.
studio_add_decal, studio_edit_decalwritePlace a library decal on the product, or move, resize, restyle, swap or rename one.
studio_remove_decaldestructiveRemove a decal. Undo doesn't bring it back.

Lights, environment and background

ToolKindWhat it does
studio_get_light_rigreadEvery light with its direction, distance, strength, softness and colour.
studio_list_light_presets, studio_list_light_assetsreadThe workspace's lighting presets, and the IES profiles and gobos a light can use.
studio_adjust_lightingwriteRedesign the lighting from a description, or match the lighting in a photo. Spends usage.
studio_adjust_light_rigwriteTurn, brighten or dim the whole light setup at once.
studio_edit_lightwriteChange one light directly.
studio_get_environment, studio_search_hdri_libraryreadThe HDRI in use, and the HDRI catalog.
studio_set_environmentwriteSwitch, turn, strengthen, blur or recolour the HDRI, or show it as the background.
studio_get_backdropreadThe loaded backdrop, the others available, and its editable pieces.
studio_set_backdropwriteLoad a different backdrop.
studio_customize_backdropwriteChange one piece of the backdrop: its colour, visibility, or the floor material.
studio_list_post_process_params, studio_get_post_processreadThe finishing controls you can set, and their current values.
studio_set_post_process, studio_reset_post_processwriteSet film grain, vignette, bloom, exposure and the other finishing controls, or reset them.

Template and history

ToolKindWhat it does
studio_apply_templatedestructiveReplace the scene with a template's backdrop, lighting, shots, clips and props, keeping the products. The project is saved first and reloads, which can take a few minutes.
studio_undo, studio_redowriteUndo or redo the newest change in the Studio's history, like the Studio's own buttons.

Reference videos

Match a Studio clip's motion to a video. Scoring, applying and refining preview the clip in a Studio session, so they use Studio time.

ToolKindWhat it does
create_reference_upload, confirm_reference_uploadwriteUpload a reference video from disk.
import_reference_videowriteFetch a reference video from a public link.
wait_for_referencereadWait while a reference processes; when READY, its motion analysis.
get_reference_framesreadFrames of a reference at given times, or one contact sheet.
measure_reference_motionwriteTurn the agent's observations of the reference into a motion the Studio can play, checked before any Studio time is spent.
apply_reference_motion, wait_for_reference_applywrite, readWrite that motion onto a clip, and follow its progress.
compare_to_reference, wait_for_reference_comparisonwrite, readScore a clip against the reference frame by frame, and get the result.
refine_to_reference, wait_for_reference_refinewrite, readImprove a clip automatically where it doesn't match, and follow its progress.

Limits

  • 120 tool calls per minute per user. A wait_for_* tool counts as one call however long it waits.
  • delete_library_items takes up to 50 items, set_asset_properties up to 100 assets, studio_batch up to 25 calls, wait_for_studio_calls up to 50.
  • One cloud Studio session per workspace at a time.

On this page