SimpliGen Docs
AI Agents

Référence des outils MCP

Les outils que le serveur MCP SimpliGen expose aux agents IA, et l'API Control locale derrière eux.

SimpliGen est livré avec 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. Voir Connecter un agent pour configurer cela.

Outils

OutilCe qu'il fait
list_capabilitiesLister chaque préset 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'admissibilité au cloud et le coût en crédits.
get_statusRapporter 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é, comptes de présets installés pour base/edit/i2v, et enhancePresets, le nombre de présets de remontée installés).
start_engineDé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 true et get_status rapporte quand il est opérationnel. Ne fait rien si le moteur s'exécute déjà, et n'en installe jamais un manquant (connecteur 0.3.0 ou plus récent).
stop_engineArrê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_engineRedé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_projectsLister les projets (les conteneurs qui contiennent les générations).
create_projectCréer un nouveau projet.
upload_fileTélécharger une image ou vidéo locale et obtenir une handle à passer dans generate.
list_lorasLister les LoRAs utilisateur installées (nom, modèle de base, mots déclencheurs) pour que vous puissiez les passer dans generate.
generateDémarrer une génération d'image ou de vidéo. Choisir local, cloud, ou auto. Optionnellement passer loras: [{ name, weight }] (backend local, présets où inputs.supportsLoras est true ; utiliser list_loras pour les noms) et un negativePrompt. options prend les champs nommés (steps, cfg, seed, resolution, aspectRatio, durationSeconds) et tout Advanced Control que le préset déclare sous list_capabilities → options.controls, comme unlock, shift ou high_steps, comme clé de niveau supérieur (connecteur 0.2.0 ou plus récent). Retourne un id de tâche.
get_jobObtenir l'état et le résultat d'une tâche, y compris le chemin de sortie une fois qu'elle est terminée.
wait_for_resultAttendre qu'une tâche se termine, échoue ou expire.
list_jobsLister les tâches de génération récentes.
cancel_jobAnnuler une tâche en attente ou en cours d'exécution.
prepare_presetCommencer à télécharger les modèles d'un préset local pour qu'il devienne prêt à s'exécuter.
get_result_imageRetourner l'image d'une tâche terminée inline pour la visualisation. Les résultats vidéo retournent un chemin de fichier.
list_recipe_blocksLister les blocs de construction pour créer une recette : points d'entrée (créer image ou vidéo, éditer image, améliorer) et chaque préset utilisable comme étape, avec son contrat de port (entrées dont il a besoin, ce qu'il produit, points d'entrée où il s'adapte).
compose_recipeCréer une nouvelle recette à partir d'une spécification de haut niveau (étapes ordonnées épinglées à des présets, plus toute entrée) et l'enregistrer comme brouillon. SimpliGen câble automatiquement les ports, la chaîne médias étape par étape, et une entrée de prompt par étape, puis valide. Retourne l'id de recette plus la validation.
validate_recipeEffectuer un essai à vide d'une spécification de recette (ou une configuration brute) sans enregistrer, et obtenir des erreurs précises à corriger avant de composer.
list_recipesLister les brouillons de recette enregistrés sur cet appareil.
get_recipeObtenir une recette enregistrée et sa configuration complète par id.
publish_recipeSoumettre une recette enregistrée à la Creator Marketplace (en attente de révision humaine). Nécessite un compte connecté ; publie gratuitement sauf si un prix de jeton unique est défini.
run_recipeExé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 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 que de cliquer sur Generate dans le studio. Retourne un id d'exécution.
get_recipe_runStatut d'une exécution 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_runBloquer jusqu'à ce qu'une exécution de recette se termine (ou qu'un délai d'attente passe) et retourner l'exécution finale.
list_recipe_runsExécutions récentes d'une recette avec leur statut et résultats.
cancel_recipe_runArrêter une recette en cours d'exécution. Aucune étape supplémentaire ne démarre ; une étape locale en vol est interrompue.
list_subjectsChaque sujet qu'une entrée de sujet de recette peut prendre : caractères et produits, avec leurs ids.
list_productsLes produits enregistrés sur cet appareil.
create_productEnregistrer un produit à partir d'une photo téléchargée (nom, description, catégorie) pour que Product Studio et les recettes UGC puissent l'utiliser. Retourne l'id du produit.
remove_productSupprimer un produit et sa photo.
list_charactersLister tous les caractères actifs dans le Character Studio.
get_characterObtenir les détails et images d'un seul caractère par id.
list_character_featuresLister toutes les fonctionnalités d'identité (teinte de peau, cheveux, etc.) et leurs options, pour les utiliser lors de la création d'un caractère par description.
list_character_presetsLister les présets installés disponibles pour chaque rôle de caractère : génération de portrait de base, édition d'identité, animation image-à-vidéo, et amélioration (remontée). Chaque préset d'amélioration inclut un tableau supportedScales.
create_characterCréer un nouveau caractère. Prend en charge trois chemins : décrire (générer un portrait de base à partir de sélections de fonctionnalités), télécharger (utiliser votre propre image comme base), et vision-recréer (fonctionnalités décrites par l'agent à partir d'une photo utilisateur). En mode génération, l'outil interroge en interne jusqu'à ce que le portrait de base soit prêt et retourne l'objet caractère prêt. En mode téléchargement, le caractère est prêt immédiatement.
generate_character_imageGénérer une image de scène pour un caractère existant par prompt. Accepte un presetId optionnel pour sélectionner quel préset d'édition d'identité utiliser pour cet appel. Retourne un ou plusieurs ids de tâche à interroger via wait_for_result.
generate_character_videoGénérer un clip vidéo animé pour un caractère existant. Accepte optionnellement framePresetId (préset d'édition d'identité pour l'étape de cadre) et videoPresetId (préset i2v pour l'étape d'animation). Retourne les ids de tâche pour les étapes de cadre et d'animation.
generate_character_frameGénérer un seul photogramme immobile pour un caractère sans l'animer. Utile quand vous voulez examiner ou améliorer le cadre avant de l'animer. Accepte un presetId optionnel. Retourne { jobIds: [...] } ; utilisez jobIds[0] comme id de tâche de cadre.
animate_characterAnimer un caractère à partir d'un cadre complété ou de tout travail d'image terminé. Passer jobId (un id de tâche d'une génération terminée) ou un filePath (chemin d'image local absolu). Accepte un videoPresetId optionnel. Retourne un id de tâche vidéo.
set_character_presetDéfinir un préset par défaut sticky par caractère pour la génération d'image (imagePresetId) et/ou la génération vidéo (videoPresetId). Passer null pour effacer un défaut. Les appels ultérieurs à generate_character_image et generate_character_video utilisent ces valeurs par défaut sauf s'ils sont remplacés par appel.
enhance_character_mediaAméliorer ou améliorer une image ou 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 remontée), keepResolution (améliorer puis redimensionner à la taille 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 amélioré). Retourne un id de tâche.
regenerate_character_baseRégénérer le portrait de base pour un caractère existant sur place, en changeant optionnellement vers un préset de base différent ou en mettant à jour l'identité. Aucun nouveau caractère n'est créé. Interroge en interne, accepte automatiquement la nouvelle base, et retourne l'objet caractère prêt. L'agent n'a pas besoin d'interroger un id de tâche après.
remove_characterSupprimer définitivement un caractère et ses données associées.

Comment cela se connecte

L'agent exécute le serveur MCP avec npx -y @simpligen/mcp sur stdio. Le serveur s'authentifie à 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éer un jeton sous Paramètres, dans la section "Connecter un agent".

Créer une intégration personnalisée ?

Les outils MCP transmettent à une API Control HTTP locale que vous pouvez appeler directement depuis n'importe quel langage. Voir la référence de l'API Control.

Limites de dépenses

Chaque jeton peut avoir une limite de dépenses. Une limite vide signifie une utilisation cloud illimitée, 0 signifie génération locale uniquement, et un nombre positif plafonne la dépense cloud à ce nombre de crédits. La génération locale est toujours autorisée et ne compte jamais pour la limite.