本文へ移動
CMO AI Pro
ログイン

CMO AI Pro Developers

基盤ツール

案件、商品マスタ、参考画像、ジョブ、クレジット残高、制作手順書を扱う10のツールの仕様です。

最終更新日:2026年10月26日

案件の作成・把握、商品マスタ保存、AI処理の追跡、クレジット残高とプラン・トライアルの状況の確認、制作手順書の取得に使う11のツールです。 クレジットは消費しません。変更系ツールには idempotency_key が必要です。

対象は、APIキーに固定された組織のデータだけです。組織外のIDを指定した場合は not_found が 返ります。同じ組織の案件は作成者に関係なく共有され、他のメンバーが作成した案件も取得できます。

通常の案件が持つ状態は active(有効)と archived(アーカイブ)の2つです。案件自体に draft(下書き)はなく、新規作成するとPro UIと同じくすぐ active になります。

list_projects

利用可能な案件を、更新日時の新しい順で取得します。返るのは有効な案件(status: "active")だけです。

パラメータ

パラメータはありません。

応答

フィールド内容
projects[].id案件ID(他ツールの project_id に使う)
projects[].name案件名
projects[].status案件の状態
projects[].created_at作成日時
projects[].updated_at更新日時

例

json
{
  "ok": true,
  "data": {
    "projects": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "案件名",
        "status": "active",
        "created_at": "2026-08-01T00:00:00.000Z",
        "updated_at": "2026-08-20T00:00:00.000Z"
      }
    ]
  }
}

create_project

APIキーに固定された組織へ、有効な案件(status: "active")を作成します。作成後は同じ組織の メンバーにもPro UIとMCPから見えます。同じ idempotency_key で再試行しても案件は重複しません。

パラメータ

パラメータ型必須既定値制約
name文字列必須—1〜160文字
idempotency_key文字列必須—1〜128文字。同じ操作の再試行では同じ値を使う

応答

フィールド内容
project作成された案件。id、name、status、作成・更新日時を含む
reused同じ冪等キーで作成済みの案件を返した場合は true

例

json
{
  "name": "新商品A",
  "idempotency_key": "project-new-product-a-20260907"
}

get_project

案件の詳細と、参考資料・リサーチ本文・戦略仮説・バナーの件数概要を取得します。 本文は含みません。作業を始める前の状況把握に使います。

パラメータ

パラメータ型必須既定値制約
project_id文字列必須—UUID

応答

フィールド内容
project案件の情報
summary.materials.total参考資料の件数
summary.materials.ready利用可能な状態の参考資料の件数
summary.hasResearchDocumentリサーチ本文があるか
summary.strategies.total戦略仮説の件数(アーカイブ済みを除く)
summary.strategies.adopted採用済みの戦略仮説の件数
summary.banners.totalバナーの件数

参考資料の件数には、手動追加分とリサーチ収集分の両方が含まれます。

エラー

code発生条件
not_found案件が存在しない、または組織外

upsert_product_master

案件に商品マスタを保存します。案件ごとに1件で、すでに存在する場合は入力内容で上書きします。

パラメータ

パラメータ型必須既定値制約
project_id文字列必須—UUID
name文字列必須—1〜160文字
url文字列またはnull任意nullURL。空文字も未指定として保存
notes文字列任意空文字最大20,000文字
idempotency_key文字列必須—1〜128文字。同じ操作の再試行では同じ値を使う

応答

フィールド内容
product.id商品マスタID
product.project_id案件ID
product.name商品名
product.url商品URL。未指定時は null
product.notes商品メモ。未指定時は null
product.created_at作成日時
product.updated_at更新日時

エラー

code発生条件
not_found案件が存在しない、または組織外

get_job_status

AI処理の状態・進捗・経過時間を取得します。生成開始系ツールが返した jobId を指定します。

パラメータ

パラメータ型必須既定値制約
job_id文字列必須—UUID

応答

フィールド内容
idジョブID
type処理の種類
status保存されている状態
displayStatus表示用の状態。長時間更新がない場合は stale
errorMessage失敗時のメッセージ。成功時は空
errorCode失敗区分(漫画ショート動画の [MSV:…] や画像の [IMAGE_GEN:…] から読み取った code)。該当なしは null
retryable再試行の目安(true / false)。区分不明・画像失敗は null
progress処理の進捗(種類ごとに内容が異なる)
elapsedMs経過時間(ミリ秒)

displayStatus が stale の場合、処理が中断した可能性があります。結果を確認したうえで、 必要であれば新しい idempotency_key で開始しなおしてください。

エラー

code発生条件
not_foundジョブが存在しない、または組織外

ポーリングの目安

生成処理は数十秒から数分かかります。1分あたりの呼び出し上限に収まるよう、間隔を空けて確認して ください。詳しくは利用上限を参照してください。

get_credit_balance

クレジットの課金状態と利用可能な残高を取得します。生成を始める前の確認に使います。

パラメータ

パラメータはありません。

応答

フィールド内容
billing課金モード。off の場合、残高は返りません
total利用可能な合計(トライアルの残り+月次付与分+購入分)
monthlyBalance月次付与分の残高
purchasedBalance購入分の残高
trialCarryoverBalance契約後も使えるトライアルの残り(期限内だけ。ないときは 0)
trialCarryoverExpiresAtトライアルの残りを使える期限(ISO 8601。ないときは null)
statusクレジットアカウントの状態

生成時はトライアルの残り、月次付与分、購入分の順に消費されます。

get_plan_status

プラン・料金・無料トライアルの期限・契約の方法・残りクレジットを取得します。無料トライアル中の組織と、 トライアルが終了した組織だけに表示されます(有料プランの組織には表示されません)。クレジットは消費しません。 トライアルが終了した組織では、このツールだけが実行できます。契約や支払いはMCPからはできず、組織の管理者が CMO AI Pro の画面で行います。

パラメータ

パラメータはありません。

応答

フィールド内容
phasenot_started(トライアル未開始)、active(期間中)、ending_soon(終了24時間以内)、granted(終了後も運営の付与残高あり)、ended(終了)、no_trial_credit(トライアルのクレジットなし)
trial開始・終了の日時(endsAtJst は日本時間の表記)、残り時間、期間の長さ(時間)
creditstotal・monthly・purchased。終了した期間の月次付与分は含めません
plans有料プランの一覧。名称、月額(税抜・税込)、利用人数(null は上限なし)、毎月のクレジット、記事分析・動画分析・文章制作がそのプランの条件に入るか
contract契約ページのURL(設定がない環境では null)、契約できるのは組織の管理者だけであること、呼び出した利用者の役割、自動更新、契約後の扱い
message利用者へそのまま伝えられる短い文

get_workflow_guide

CMO AI Pro で制作を進める手順書(Markdown)を返します。漫画制作は topic manga(目次)と 工程別 topic、ショート動画は manga-short-video で本文を取得できます。initialize の instructions は短い案内のみで、本文はこのツール・プロンプト manga / manga_short_video・ 資料 cmo-ai-pro://guides/<topic> で同じ内容を返します。

パラメータ

パラメータ型必須既定値制約
topic文字列任意—manga/manga-flow/manga-name/manga-panels/manga-repair/manga-short-video/manga-short-video-voice/manga-short-video-sound/manga-short-video-audio/manga-short-video-video/writing/writing-flow/writing-references/writing-video/writing-article/article-video/article-video-assets/article-video-video/article-video-review-repair/article-editor

応答

topic を省略した場合は version と guides(topic・title・description の配列)が返ります。 topic を指定した場合は version・topic・title・markdown(本文)が返ります。

list_reference_images

案件の「前提情報」に登録された参考画像を取得します。組織の参考バナー・参考記事素材(記事画像素材)のテンプレートとは別です。

パラメータ

パラメータ型必須既定値制約
project_id文字列必須—必須。案件のUUID
limit整数任意501〜100。既定50
offset整数任意00以上。既定0
include_signed_urls真偽値任意true画像表示URLを含めるか。既定true

応答

referenceImages に id、fileName、usageRole、createdAt、imageUrl が返ります。 作成日時とIDの降順で、続きがある場合は nextOffset を次の offset に指定します。 画像URLは10分有効です。期限切れ時は再取得してください。URLを要求しない場合は imageUrl がnullです。

prepare_reference_image_upload

案件専用の署名付きアップロードURLを発行します。クレジットは消費しません。

パラメータ

パラメータ型必須既定値制約
project_id文字列必須—必須。案件のUUID
file_name文字列必須—必須。1〜200文字
content_type文字列必須—必須。image/png / image/jpeg / image/webp
size_bytes整数必須—必須。1〜3,932,160バイト(画面と同じ1枚あたりの上限)
checksum_sha256文字列必須—必須。画像ファイルのSHA256(64桁の16進数)
idempotency_key文字列必須—必須。同じ発行要求の再試行には同じ値を使う

応答

uploadUrl、storagePath、requiredHeaders、declarations が返ります。 requiredHeaders を付けて uploadUrl に画像のバイナリをPUTし、次の登録ツールを呼びます。 アップロード先URLは2時間有効です。URL発行・アップロードだけでは案件に登録されません。

register_reference_image

アップロードした画像の実体・形式・バイト数・SHA256を検証して案件へ登録します。

パラメータ

パラメータ型必須既定値制約
project_id文字列必須—必須。アップロード先を発行した案件のUUID
storage_path文字列必須—必須。発行結果の storagePath
file_name文字列必須—必須。画面で表示する名前(1〜200文字)
usage_role文字列任意referenceperson_locked(人物固定)/ reference(見た目固定、既定)/ mood_reference(自由参考)
declared_content_type文字列必須—必須。発行時の content_type
declared_size_bytes整数必須—必須。発行時の size_bytes
declared_checksum_sha256文字列必須—必須。発行時の checksum_sha256
idempotency_key文字列必須—必須。同じ登録要求の再試行には同じ値を使う

応答

referenceImageId、fileName、usageRole、reused が返ります。同じアップロードを再登録しても1件だけ保存され、最初の名前・役割を維持します。 別案件のパスは not_found、画像と申告値の不一致は validation_error です。 返された画像IDは、漫画修正の reference_image_ids やバナー生成の selected_reference_image_ids に使えます。

#### 文章制作の手順(Team以上)

Team・Agency・Enterpriseでサービス利用資格と分析の公開条件を満たすと、次の5手順も取得できます。Soloの一般MCPでは表示・取得できません。文章を書くのは外部AIエージェントで、CMO AI Proは参考の型と原稿点検を返します。新しい記事・動画の分析は、開始前に利用者の確認を取ってから分析MCPで開始できます。

topic用途
writing目次と初回の準備
writing-flow全体の流れと確認箇所。最初に読む
writing-references完了済み分析から参考候補を提示する
writing-video冒頭5案、台本、テロップ、画面メモ
writing-articleタイトル・冒頭5案、ブロック表と質問、本文

prompts/getのwriting、resources/readのcmo-ai-pro://guides/writingからも同じ手順を読めます。参考検索・型取得・原稿点検は0クレジット。詳しい準備と9ツールは分析・参考ツールを参照してください。

#### 記事LPの組み立て手順(Team以上)

記事LPエディタが使える組織(Team・Agency・Enterpriseの契約中の組織)で、MCPから記事LPを組み立てるときは topic article-editor を読みます。下書きの作成、素材の入れ方(素材ライブラリ・完成した記事LP動画・アップロード)、装飾・ボタン・追従ボタンの入れ方、人の確認の取り方をまとめています。仕上がりの確認とZIPでの書き出しは利用者が画面で行い、MCPから公開・削除はしません。ツールの詳細は記事LPエディタツールを参照してください。

topic用途
article-editor記事LPの下書き作成から、素材・装飾・ボタン・追従ボタンの入れ方と人の確認まで