Référence des outils MCP
Les outils que le serveur MCP SimpliGen expose aux agents IA, et l'API Control locale qui les pilote.
SimpliGen inclut un serveur MCP (@simpligen/mcp) qui connecte un agent IA à l'application SimpliGen en cours d'exécution via une connexion locale authentifiée par jeton. L'agent appelle les outils MCP ; le serveur les transmet à l'API Control locale de l'application. Consultez Connecter un agent pour configurer cela.
Outils
| Outil | Ce qu'il fait |
|---|---|
list_capabilities | Lister chaque preset avec lequel l'agent peut générer (image ou vidéo), ses entrées et options, s'il est prêt localement, et l'éligibilité cloud et le coût en crédits. |
get_status | Signaler l'état du moteur, si le cloud est connecté, le solde des crédits, le projet actif, et le bloc de capacité characters (drapeau activé, nombre de presets installés pour base/edit/i2v, et enhancePresets, le nombre de presets de mise à l'échelle installés). |
start_engine | Démarrer le moteur local s'il n'est pas déjà en cours d'exécution. Retourne l'état du moteur ; quand un démarrage à froid dépasse l'appel, engineStarting est vrai et get_status signale quand il est actif. Ne fait rien si le moteur est déjà en cours d'exécution, et n'installe jamais un moteur manquant (connecteur 0.3.0 ou plus récent). |
stop_engine | Arrêter le moteur local et libérer sa VRAM. La génération cloud n'est pas affectée (connecteur 0.3.0 ou plus récent). |
restart_engine | Redémarrer le moteur local, après l'installation ou la suppression d'un nœud personnalisé, ou quand il est bloqué (connecteur 0.3.0 ou plus récent). |
list_projects | Lister les projets (les conteneurs qui détiennent les générations). |
create_project | Créer un nouveau projet. |
upload_file | Télécharger une image ou une vidéo locale et obtenir un handle à passer dans generate. |
list_loras | Lister les LoRAs utilisateur installées (nom, modèle de base, mots-clés de déclenchement) pour que vous puissiez les passer dans generate. |
generate | Démarrer une génération d'image ou de vidéo. Choisir local, cloud, ou auto. Optionnellement passer loras: [{ name, weight }] (backend local, presets où inputs.supportsLoras est vrai ; utiliser list_loras pour les noms) et un negativePrompt (termes supplémentaires, ajoutés après le négatif par défaut du preset ; sur les exécutions cloud le preset par défaut est utilisé tel quel). options prend les champs nommés (steps, cfg, seed, resolution, aspectRatio, durationSeconds) et tout Contrôle Avancé que le preset déclare sous list_capabilities → options.controls, tel que unlock, shift ou high_steps, comme clé de haut niveau (connecteur 0.2.0 ou plus récent). Retourne un id de tâche. |
get_prompt_guide | Lire le guide d'invite pour un preset (presetId) avant de rédiger son invite : comment le modèle lit une invite, structure, longueur, vocabulaire de caméra et mouvement, négatifs, vocabulaire et exemples de caractères. La réponse contient family, generic (vrai quand aucun guide spécifique au modèle n'existe) et le text du guide. Connecteur 0.6.0 ou plus récent ; generate indique aux agents de l'appeler d'abord. |
get_job | Obtenir le statut et le résultat d'une tâche, y compris le chemin de sortie une fois terminée. |
wait_for_result | Attendre qu'une tâche se termine, échoue ou expire. |
list_jobs | Lister les tâches de génération récentes. |
cancel_job | Annuler une tâche en file d'attente ou en cours d'exécution. |
prepare_preset | Commencer à télécharger les modèles d'un preset local pour qu'il soit prêt à fonctionner. |
get_result_image | Retourner l'image d'une tâche terminée en ligne pour visualisation. Les résultats vidéo retournent un chemin de fichier. |
list_recipe_blocks | Lister les blocs de construction pour la création d'une recette : points d'entrée (créer une image ou une vidéo, éditer une image, mettre à l'échelle) et chaque preset utilisable comme étape, chacun avec son contrat de port (entrées dont il a besoin, ce qu'il produit, quels points d'entrée le conviennent). |
compose_recipe | Créer une nouvelle recette à partir d'une spécification de haut niveau (étapes ordonnées épinglées à des presets, plus toute entrée) et l'enregistrer en tant que brouillon. SimpliGen fait le câblage automatique des ports, la chaîne médias étape par étape, et une entrée d'invite par étape, puis valide. Retourne l'id de recette plus la validation. |
validate_recipe | Test sec d'une spec de recette (ou une config brute) sans enregistrement, et obtenir les erreurs précises à corriger avant de composer. |
list_recipes | Lister les brouillons de recette enregistrés sur cet appareil. |
get_recipe | Obtenir une recette enregistrée et sa configuration complète par id. |
publish_recipe | Soumettre une recette enregistrée au Creator Marketplace (en attente d'examen humain). Nécessite un compte connecté ; publie gratuitement sauf si un prix de jeton unique est défini. |
run_recipe | Exécuter une recette installée (celles dans UGC Studio et Product Studio, ou un brouillon) avec ses entrées remplies. Une entrée de sujet prend un id de caractère ou de produit, les entrées médias prennent des handles de téléchargement, les entrées texte et choix prennent des valeurs simples. Même pipeline qu'en cliquant sur Generate dans le studio. Retourne un id de lancement. |
get_recipe_run | Statut d'un lancement de recette : statut global, chaque étape avec son statut et résultat, et le chemin du résultat final une fois terminé. |
wait_for_recipe_run | Bloquer jusqu'à ce qu'un lancement de recette se termine (ou qu'un délai d'expiration passe) et retourner le lancement final. |
list_recipe_runs | Lancements récents d'une recette avec leur statut et résultats. |
cancel_recipe_run | Arrêter une recette en cours d'exécution. Aucune étape supplémentaire ne démarre ; une étape locale en vol est interrompue. |
list_subjects | Chaque sujet qu'une entrée de sujet de recette peut prendre : caractères et produits, avec leurs ids. |
list_products | Les produits enregistrés sur cet appareil. |
create_product | Enregistrer un produit à partir d'une photo téléchargée (nom, description, catégorie) afin que Product Studio et les recettes UGC puissent l'utiliser. Retourne l'id du produit. |
remove_product | Supprimer un produit et sa photo. |
list_characters | Lister tous les caractères actifs dans le Character Studio. |
get_character | Obtenir les détails et les images pour un seul caractère par id. |
list_character_features | Lister tous les traits d'identité (teinte de peau, cheveux, etc.) et leurs options, pour utilisation lors de la création d'un caractère par description. |
list_character_presets | Lister les presets installés disponibles pour chaque rôle de caractère : génération de portrait de base, édition d'identité, animation image-vers-vidéo, et amélioration (mise à l'échelle). Chaque preset d'amélioration inclut un tableau supportedScales. |
create_character | Créer un nouveau caractère. Supporte trois chemins : décrire (générer un portrait de base à partir de sélections de caractéristiques), télécharger (utiliser votre propre image comme base), et vision-recréer (caractéristiques décrites par l'agent à partir d'une photo utilisateur). En mode génération, l'outil fait des sondages internes jusqu'à ce que le portrait de base soit prêt et retourne l'objet de caractère prêt. En mode téléchargement, le caractère est prêt immédiatement. |
generate_character_image | Générer une image de scène pour un caractère existant par invite. Accepte un presetId optionnel pour sélectionner quel preset d'édition d'identité utiliser pour cet appel. Retourne un ou plusieurs ids de tâche à sonder via wait_for_result. |
generate_character_video | Générer un clip vidéo animé pour un caractère existant. Accepte un framePresetId optionnel (preset d'édition d'identité pour l'étape de cadre) et un videoPresetId (preset i2v pour l'étape d'animation). Retourne les ids de tâche pour l'étape de cadre et l'étape d'animation. |
generate_character_frame | Générer un cadre unique et statique pour un caractère sans l'animer. Utile quand vous voulez examiner ou améliorer le cadre avant l'animation. Accepte un presetId optionnel. Retourne { jobIds: [...] }; utiliser jobIds[0] comme id de tâche de cadre. |
animate_character | Animer un caractère à partir d'un cadre terminé ou de n'importe quel id de tâche d'image terminée. Passer jobId (un id de tâche de n'importe quelle génération terminée) ou un filePath (chemin absolu d'image locale). Accepte un videoPresetId optionnel. Retourne un id de tâche vidéo. |
set_character_preset | Définir un preset par défaut collant par caractère pour la génération d'image (imagePresetId) et/ou la génération de vidéo (videoPresetId). Passer null pour effacer un défaut. Les appels suivants à generate_character_image et generate_character_video utilisent ces défauts sauf si annulés par appel. |
enhance_character_media | Mettre à l'échelle ou améliorer une image ou une vidéo de caractère. La source peut être une tâche terminée (jobId), un fichier téléchargé (handle filePath), ou le portrait de base du caractère (target: 'base'). Accepte scale (facteur de mise à l'échelle), keepResolution (mettre à l'échelle puis redimensionner à la taille de la source pour un résultat plus net de même taille), et applyAsBase (remplacer le portrait de base du caractère par le résultat mis à l'échelle). Retourne un id de tâche. |
regenerate_character_base | Régénérer le portrait de base pour un caractère existant sur place, optionnellement en passant à un preset de base différent ou en mettant à jour l'identité. Aucun nouveau caractère n'est créé. Fait des sondages internes, accepte automatiquement la nouvelle base, et retourne l'objet de caractère prêt. L'agent n'a pas besoin de sonder un id de tâche par la suite. |
remove_character | Supprimer définitivement un caractère et ses données associées. |
list_films | Lister les films de Video Studio d'un projet (connecteur 0.5.0 ou plus récent, comme tous les outils de film ci-dessous). |
create_film | Créer un film vide : forme, résolution, où il est rendu, presets par type de plan. Répond avec sa timeline. |
get_film | Lire la timeline d'un film : tempo, cast, chaque clip avec son numéro, début et longueur en secondes et barres, plans et statut de prise, les pistes, marqueurs et plage d'export. |
update_film_settings | Changer la forme du film, la résolution, où il est rendu, les presets, Sujet et style, et le cast et la localisation que chaque clip hérite. |
add_track | Mettre un fichier audio téléchargé sur la timeline : chant, musique, dialogue ou effets. |
move_track | Déplacer l'audio d'une piste, la rendre muette, ou définir son volume. |
detect_tempo | Définir le tempo du film et les lignes de barres à partir de sa chanson. Après cela, les temps peuvent être donnés en barres. |
add_clip | Ajouter un clip vide à un moment, pour une longueur. |
update_clip | Écrire un clip en une seule étape : plans (invite, longueur, ligne parlée ou chantée, qui la dit, cadrage), cast, localisation, comment il commence (frais ou continuer à partir du clip précédent ; none et frame sont aussi acceptés, comme frais et continuer), quelles pistes il entend, preset. |
move_clip | Déplacer un clip vers un nouveau début ou une autre piste vidéo. |
trim_clip | Changer la longueur d'un clip, ou où il commence à l'intérieur de sa prise. |
remove_clip | Supprimer un clip. |
apply_film_plan | Disposer un brouillon entier en une seule étape : clips sur les barres avec leurs plans, cast et liens. Chaque problème revient à la fois ; rien ne change sauf si tout cela est valide. |
set_fades | Fondre un clip ou une piste en entrée et en sortie. |
add_marker | Mettre un marqueur nommé sur la règle. |
set_export_range | Exporter uniquement une partie du film, ou tout. |
render_clips | Rendre les clips qui en ont besoin, ou ceux nommés. Répond immédiatement avec ce qui a commencé, ce qui est maintenu, et le coût cloud. |
wait_for_renders | Attendre qu'aucun clip ne soit en cours de rendu et répondre avec la timeline. |
list_takes | Lister les prises d'un clip. |
use_take | Faire d'une des prises d'un clip celle qu'il affiche. |
export_film | Assembler le film en une vidéo avec sa musique et répondre avec le chemin du fichier. |
list_locations | Lister les emplacements de la Bibliothèque. |
create_location | Enregistrer un emplacement à partir d'une image téléchargée ou d'une tâche d'image terminée. |
Avec le film ouvert dans Video Studio, chaque modification qu'un agent effectue apparaît immédiatement et s'annule avec Ctrl+Z. Consultez Un agent crée un clip vidéo musical pour une présentation complète.
Comment cela se connecte
L'agent exécute le serveur MCP avec npx -y @simpligen/mcp sur stdio. Le serveur s'authentifie auprès de l'application avec un jeton d'appairage (SIMPLIGEN_TOKEN) et trouve le port local de l'application automatiquement. L'application SimpliGen doit être en cours d'exécution. Créez un jeton dans Paramètres, dans la section « Connecter un agent ».
Créer une intégration personnalisée ?
Les outils MCP transfèrent à une API Control HTTP locale que vous pouvez appeler directement à partir de n'importe quel langage. Consultez la référence de l'API Control.
Limites de dépenses
Chaque jeton peut porter un plafond de dépenses. Un plafond vide signifie une utilisation cloud illimitée, 0 signifie une génération locale uniquement, et un nombre positif limite les dépenses cloud à ce nombre de crédits. La génération locale est toujours autorisée et ne compte jamais contre le plafond.
Un agent crée un clip vidéo musical
Donnez à un agent IA une chanson et une distribution, et regardez-le construire un clip vidéo dans le Video Studio, plan par plan, en direct.
Référence de l'API Control
L'API HTTP locale que SimpliGen expose sur votre machine, pour construire des intégrations personnalisées et exécuter des générations en mode headless.