MCPUpdated for MCP and REST v1

MCP Tools

Novabrand exposes nine MCP tools for project discovery, setup, image lookup, generation, polling, and credit checks.

Tool reference

ToolPurposeRequired input
list_projectsList account projects and brand readiness.none
create_projectCreate a project from a brand website.name, website_url
check_brand_analysisPoll setup status after project creation.brand_analysis_id
list_product_imagesList product images available in a project.project_id
list_modelsList reusable brand model images.project_id
generate_adGenerate ad creatives asynchronously.project_id, product_image_uuids, generation_type
generate_model_shotGenerate model photoshoots asynchronously.project_id, product_image_uuids, model_image_uuids
check_generationPoll generation status and final assets.kind, id
get_creditsRead remaining generation credits and plan limits.none

Generation options

FieldApplies toNotes
generation_typegenerate_adcampaign, pdp_hero, text_ad, ugc_ad, lifestyle, or studio.
variant_countgenerate_ad, generate_model_shotInteger from 1 to 5.
aspect_ratiogenerate_adOptional values such as 1:1, 4:5, 9:16, or 16:9.
qualitygenerate_adOptional values such as 1K, 2K, or 4K. Higher quality can cost more credits.
custom_promptgenerate_adOptional ad/product photoshoot prompt, maximum 600 characters.
scenegenerate_model_shotOptional model photoshoot scene prompt, maximum 500 characters.
guidance.stylegenerate_model_shotugc, balanced, or editorial.
guidance.framinggenerate_model_shotauto, wide, portrait, hands, detail, or shoulder.

Creative types

generation_typeBest for
campaignA polished campaign creative with the product in an on-brand scene.
pdp_heroA hero image suited to a product detail page.
text_adA creative formatted for text-forward ad placements.
ugc_adA casual, user-generated-content style ad.
lifestyleThe product shown in a real-world lifestyle setting.
studioA studio-style product shot on a clean background.

Image list result fields

list_product_images returns product_images and list_models returns model_images. Pass the file_uuid of each item as product_image_uuids or model_image_uuids when you generate.

FieldMeaning
file_uuidThe image id to pass into generate_ad or generate_model_shot.
urlA viewable URL for the image.
file_nameThe original file name.
project_uuidThe project the image belongs to.
sourcemodel_images only. How the model image was added, for example uploaded.

Polling result fields

check_brand_analysis and check_generation share the same status fields. Keep polling until the work finishes, then read the result.

FieldMeaning
statusqueued, processing, completed, or failed.
progressProgress from 0 to 100.
current_stageBrand setup moves through queued, analyzing, finalizing, and complete. Generation moves through preparing, refining, generating, finalizing, and complete.
completedcheck_generation only. Becomes true once the asset is ready.
project_uuidcheck_brand_analysis only. Present once brand setup completes.
brand_profilecheck_brand_analysis only. The brand profile produced once setup completes.
assetcheck_generation only. The generated asset object once completed, otherwise null.
error_messageA safe summary when a job fails, otherwise null.

Generated asset fields

When check_generation reports completed: true, the asset holds one entry per variation in generated_assets.

FieldMeaning
generated_assets[].asset_urlThe image URL for the variation.
generated_assets[].preview_urlA smaller preview image URL.
generated_assets[].titleA suggested title when one is generated.
generated_assets[].ad_copyGenerated ad copy when available.
generated_assets[].is_watermarkedtrue when the returned image is a watermarked preview.
generation_typeThe creative type that was requested.
variant_countHow many variations were generated.

Watermarking

Free plans return generated images as watermarked previews while paid plans return the original-resolution images. Check is_watermarked before you publish an asset.

Credit fields

FieldMeaning
limitGeneration credits included in the current plan period.
usedCredits already used in the current period.
remainingCredits still available this period.
planThe readable plan name.
billingPeriodStartThe start of the current credit period.
billingPeriodEndThe end of the current credit period.

How credits are counted

Each generation costs variant_count multiplied by a quality factor, so higher output quality costs more per image. The exact charge for a request is returned as credits_used when the generation starts.