SimpliGen Docs
AI Agents

MCP ツール リファレンス

SimpliGen MCP サーバーが AI エージェントに公開するツールと、その背後にあるローカル Control API。

SimpliGen には MCP サーバー (@simpligen/mcp) が付属しており、AI エージェントをローカルなトークン認証接続を通じて実行中の SimpliGen アプリに接続します。エージェント が MCP ツールを呼び出し、サーバーがそれらをアプリのローカル Control API に転送します。設定についてはエージェントを接続するを参照してください。

ツール

ツール機能
list_capabilitiesエージェントが生成できるすべてのプリセット(画像またはビデオ)、その入力とオプション、ローカルで準備完了しているかどうか、クラウド適性とクレジットコストをリストアップします。
get_statusエンジンの状態、クラウドの接続状況、クレジット残高、アクティブなプロジェクト、および characters 機能ブロック(有効フラグ、ベース/編集/i2v のインストール済みプリセット数、および enhancePresets はインストール済みアップスケール プリセット数)をレポートします。
start_engineローカルエンジンがまだ実行されていない場合は起動します。エンジン状態を返します。コールドブートがこの呼び出しを超える場合、engineStarting は true となり、get_status は起動時を報告します。エンジンが既に実行されている場合は何もしません。また、不足しているものをインストールしません(コネクタ 0.3.0 以降)。
stop_engineローカルエンジンを停止し、VRAM を解放します。クラウド生成は影響を受けません(コネクタ 0.3.0 以降)。
restart_engineローカルエンジンを再起動します。カスタムノードをインストール、または削除した後、またはウェッジ状態にある場合に使用します(コネクタ 0.3.0 以降)。
list_projectsプロジェクト(生成を保持するコンテナ)をリストアップします。
create_project新しいプロジェクトを作成します。
upload_fileローカル画像またはビデオをアップロードし、generate に渡すハンドルを取得します。
list_lorasインストール済みユーザー LoRA(名前、ベースモデル、トリガーワード)をリストアップして、generate に渡すことができます。
generate画像またはビデオの生成を開始します。local、cloud、または auto を選択します。オプションで loras: [{ name, weight }](ローカルバックエンド、inputs.supportsLoras が true のプリセット。list_loras を名前に使用)および negativePrompt を渡すことができます。options は名前付きフィールド(steps、cfg、seed、resolution、aspectRatio、durationSeconds)および list_capabilities で プリセットが options.controls の下で宣言する高度なコントロール(unlock、shift、high_steps など)をトップレベルキーとして受け付けます(コネクタ 0.2.0 以降)。ジョブ ID を返します。
get_jobジョブの状態と結果(完了後の出力パスを含む)を取得します。
wait_for_resultジョブが完了、失敗、またはタイムアウトするまで待機します。
list_jobs最近の生成ジョブをリストアップします。
cancel_jobキューに入っているまたは実行中のジョブをキャンセルします。
prepare_presetローカルプリセットのモデルダウンロードを開始して、実行準備が完了した状態にします。
get_result_image完了したジョブの画像をインラインで表示用に返します。ビデオ結果はファイルパスを返します。
list_recipe_blocksレシピ作成の構成要素をリストアップします。エントリポイント(画像またはビデオの作成、画像の編集、アップスケール)およびステップとして使用可能なすべてのプリセット。各プリセットにはそのポートコントラクト(必要な入力、生成内容、適合するエントリポイント)が含まれます。
compose_recipe高レベル仕様(プリセットに固定された順序付きステップと任意の入力)からレシピを作成し、ドラフトとして保存します。SimpliGen がポート、ステップ間メディアチェーン、ステップあたりのプロンプト入力を自動配線し、検証します。レシピ ID と検証を返します。
validate_recipeレシピ仕様(または生のコンフィグ)をドライラン実行して保存せず、修正する前に正確なエラーを取得します。
list_recipesこのデバイスに保存されたレシピドラフトをリストアップします。
get_recipeID でレシピを保存し、その完全なコンフィグを取得します。
publish_recipe保存されたレシピを Creator Marketplace に送信します(人間によるレビュー待ち)。接続されたアカウントが必要です。1 回限りのトークン価格が設定されていない限り、無料で公開されます。
run_recipeインストール済みレシピ(UGC Studio と Product Studio、またはドラフト内)を入力を埋めて実行します。サブジェクト入力はキャラクター ID または商品 ID を受け取り、メディア入力はアップロード ハンドルを受け取り、テキストと選択入力は通常の値を受け取ります。Studio で生成をクリックするのと同じパイプライン。実行 ID を返します。
get_recipe_runレシピ実行の状態。全体的なステータス、各ステップとそのステータスおよび結果、完了後の最終的な結果パス。
wait_for_recipe_runレシピ実行が完了(またはタイムアウトが経過)するまでブロックして、最終実行を返します。
list_recipe_runsレシピの最近の実行と、そのステータスおよび結果。
cancel_recipe_run実行中のレシピを停止します。以降のステップは開始されません。ローカルの実行中ステップは割り込まれます。
list_subjectsレシピのサブジェクト入力が受け付けることができるすべてのサブジェクト。キャラクターと商品、その ID を表示します。
list_productsこのデバイスに保存されている商品。
create_productアップロードされた写真から商品を保存します(名前、説明、カテゴリー)。Product Studio と UGC レシピが使用できます。商品 ID を返します。
remove_product商品とその写真を削除します。
list_charactersCharacter Studio のすべてのアクティブなキャラクターをリストアップします。
get_characterID で単一のキャラクターの詳細と画像を取得します。
list_character_featuresすべてのアイデンティティ機能(肌色、髪型など)とそのオプションをリストアップします。説明によってキャラクターを作成する際に使用します。
list_character_presets各キャラクターロール用にインストール済みプリセットをリストアップします。ベースポートレート生成、アイデンティティ編集、image-to-video アニメーション、および拡張(アップスケール)。各拡張プリセットには supportedScales 配列が含まれます。
create_character新しいキャラクターを作成します。3 つのパスに対応しています。describe(機能選択から基本ポートレートを生成)、upload(独自の画像をベースとして使用)、および vision-recreate(ユーザーの写真からエージェントが説明した機能)。生成モードでは、ツールは基本ポートレートが準備完了になるまで内部でポーリングを行い、準備完了したキャラクターオブジェクトを返します。アップロードモードでは、キャラクターはすぐに準備完了です。
generate_character_imageプロンプトで既存のキャラクターのシーン画像を生成します。オプションで presetId を受け付けて、このコール用に使用するアイデンティティ編集プリセットを選択します。wait_for_result を通じてポーリングする 1 つ以上のジョブ ID を返します。
generate_character_video既存のキャラクターのアニメーション動画クリップを生成します。オプションで framePresetId(フレームステップ用のアイデンティティ編集プリセット)および videoPresetId(アニメートステップ用の i2v プリセット)を受け付けます。フレームと アニメーションステップの両方のジョブ ID を返します。
generate_character_frameキャラクターのアニメーション化なしで単一のスティルフレームを生成します。アニメーション化する前にフレームをレビューまたは拡張したい場合に有効です。オプションで presetId を受け付けます。{ jobIds: [...] } を返します。jobIds[0] をフレームジョブ ID として使用します。
animate_character完了したフレームまたは完了した画像ジョブからキャラクターをアニメーション化します。jobId(完了した生成からのジョブ ID)または filePath(絶対ローカル画像パス)を渡します。オプションで videoPresetId を受け付けます。ビデオジョブ ID を返します。
set_character_preset画像生成(imagePresetId)または動画生成(videoPresetId)用のキャラクターごとのスティッキーなデフォルトプリセットを設定します。null を渡してデフォルトをクリアします。その後の generate_character_image および generate_character_video への呼び出しは、コールごとのオーバーライドがない限りこれらのデフォルトを使用します。
enhance_character_mediaキャラクター画像またはビデオをアップスケールまたは拡張します。ソースは完了したジョブ(jobId)、アップロード済みファイル(filePath ハンドル)、またはキャラクターベースポートレート(target: 'base')です。scale(アップスケール係数)、keepResolution(アップスケールしてからソースサイズにサイズ変更して、より鮮明な同じサイズの結果を得る)、および applyAsBase(アップスケールされた結果でキャラクターベースポートレートを置き換える)を受け付けます。ジョブ ID を返します。
regenerate_character_base既存のキャラクターのベースポートレートを再生成します。その場所で、オプションで異なるベースプリセットに切り替えるか、アイデンティティを更新します。新しいキャラクターは作成されません。内部でポーリングを行い、新しいベースを自動承認し、準備完了したキャラクターオブジェクトを返します。エージェントがその後ジョブ ID をポーリングする必要はありません。
remove_characterキャラクターと関連するすべてのデータを永続的に削除します。

接続方法

エージェントは npx -y @simpligen/mcp を stdin/stdout 経由で MCP サーバーを実行します。サーバーはペアリングトークン(SIMPLIGEN_TOKEN)を使用してアプリに認証し、アプリのローカルポートを自動的に見つけます。SimpliGen アプリは実行中である必要があります。設定の「エージェントを接続する」セクションでトークンを発行してください。

カスタム統合を構築していますか?

MCP ツールは、任意の言語から直接呼び出すことができるローカル HTTP Control API に転送します。Control API リファレンスを参照してください。

支出制限

各トークンには支出キャップを設定できます。空のキャップはクラウド使用が無制限を意味し、0 はローカル生成のみを意味し、正の数はクラウド支出をそのクレジット数で制限します。ローカル生成は常に許可され、キャップに対して数えられることはありません。