MCP / LOCAL STDIO

MCPから共通APIを使う

対話入力と選択:点・数値・文字・図形選択・仮表示を独自コマンドで使う

保存・書き出し、5メソッドとMCP、形式・完了・エラーの詳細

Free版とカスタマイズの利用条件

Free版は配布時の「APIサンプル」10コマンドだけを利用できます。独自DLLと変更したサンプルの実行には、有効なSTDまたはProライセンスが必要です。Free版ではサンプルの名前・IDを使っても外部DLLのコードは実行せず、本体に同梱されたサンプルを実行します。変更が反映されない場合は[読込状況]とプランを確認してください。C#/VB.NETの実習サンプルを自作DLLとして読み込む場合もSTD/Proが必要です。

MCPはFree版でも使用できます。通常の作図・編集APIは利用でき、板金・解析のAPIはライセンス判定で拒否されます。独自DLLの読込み制限とMCP接続の可否は別です。

接続設定

本体フォルダーのCustomization\Mcp\JDesignCAD.Mcp.exeがstdio方式のMCPサーバーです。MCPクライアントから起動します。TCPの待受ポートは使用せず、同じWindowsユーザーの本体へ名前付きパイプで接続します。

{
  "mcpServers": {
    "jdesigncad": {
      "command": "C:\\Program Files\\JDesignCADV1\\Customization\\Mcp\\JDesignCAD.Mcp.exe",
      "args": []
    }
  }
}

commandを実際の配置先へ変更します。同梱のmcp-config.jsonは配布先に合わせて生成されています。登録方法や設定ファイル名は使用するMCPクライアントに従ってください。

最初の確認

  1. JDesignCADを起動し、空の図面をモデル空間で開きます。
  2. cad_list_sessionsで対象ウィンドウのsessionIdを選択します。
  3. cad_get_documentとcad_get_capabilitiesで図面ID・revision・利用可能な操作を確認します。
  4. cad_get_operation_schemaで操作名の入力スキーマを取得します。
  5. cad_execute_operationで軽い操作、cad_start_operationで計算ジョブを実行します。

同一部品を分割作成した場合の合体

一つの実物部品を複数のソリッドに分けて作成した場合は、その部品の加工と、分割形状を参照する後続工程が済んだ時点で、作成途中にブーリアン合体します。アセンブリ全体が完成するまで分割したままにせず、solid.boolean に kind: "union" と対象の entityIds を渡します。例えば、一体のアームを構成する筒・腕・取付部や、同じボルトの軸と頭部が対象です。

  1. 実物で一つの部品かを確認し、その部品を構成する接続したソリッドだけを選びます。
  2. cad_start_operation で合体を計算し、cad_get_job で成功を確認します。ready の結果を cad_commit_job で確定します。
  3. 結果が1ソリッドになったことと形状を確認します。元の図形IDを使い続けず、確定後のID・revisionを使って次の加工へ進みます。

同じ形状を複数配置した別の部品、ナット、ワッシャー、ブッシュ、可動部品などは相互に合体しません。ユーザーが分離を指定したものはそのまま残します。形状間に隙間がある場合、許可なく補形状を追加したり寸法を変えたりしてつなげてはいけません。

合体が失敗した場合は元の形状を保持し、未完了であることと原因・エラーを報告します。ブロック化・グループ化や単なる重ね合わせは、ブーリアン合体の代わりにはなりません。この方針はMCPの接続時の案内と、機能一覧・計算開始ツールの説明でもAIへ伝えます。更新済みMCPサーバーへの再接続後に新しい案内が有効になります。

線分を1本作る入力例

ツールはcad_execute_operationです。角括弧の文字列を実際のID・数値・新しいUUIDに置き換えてください。

{
  "sessionId": "[対象セッションID]",
  "request": {
    "documentId": "[図面ID]", "expectedRevision": 0,
    "operationId": "[新しいUUID]", "operation": "geometry.create",
    "parameters": {
      "objects": [{"line": {
        "start": {"x":0,"y":0,"z":0},
        "end": {"x":50,"y":0,"z":0}
      }}]
    },
    "selectResult": true
  }
}

計算ジョブ

cad_start_operationに{request: OperationRequest, timeoutSeconds: 120}を渡します。cad_get_jobを適度な間隔で呼び、runningが終わるのを待ちます。readyになったら図面のrevisionが計算開始時と一致することを確認し、cad_commit_jobへ新しいoperationIdを付けて渡します。ジョブ開始のoperationIdをcommitに使い回してはいけません。

計測・解析はcompletedになり、cad_get_job_dataで結果をページ取得します。cad_cancel_jobは計算中の中止またはready結果の破棄です。元の図面は変わりません。接続が切れても計算は自動中止されないため、同じ開始リクエストを再送してジョブIDを確認できます。

ツールの対応

用途ツール
接続・情報cad_list_sessions / cad_get_document / cad_get_capabilities / cad_get_operation_schema
選択・図形取得cad_get_selection / cad_get_entities / cad_get_entity_details / cad_get_topology / cad_get_attributes / cad_get_layers / cad_query
即時編集cad_create_geometry / cad_create_curves / cad_set_selection / cad_translate_entities / cad_delete_entities / cad_execute_operation
計算cad_start_operation / cad_get_job / cad_cancel_job / cad_commit_job / cad_get_job_data
履歴cad_undo / cad_redo
画面操作cad_get_interactive_commands / cad_launch_interactive_command

計測・設定・作画・アニメーション

cad_get_capabilitiesで操作を探し、cad_get_operation_schemaで引数を確認します。即時操作はcad_execute_operation、worker/worker-dataはcad_start_operationから開始します。

目的操作・取得方法
分かれた線・弧から閉図形を認識して計測measure.contour。候補IDと種となる1辺・計測平面を指定。measure.highlightで認識輪郭を確認/解除。
線幅・線種を登録styles.lineWidth / styles.linePattern。同名は更新。cad_queryのstylesで値・現在値を確認。
クロソイド・基本型・横断線geometry.clothoid / geometry.clothoid.basic / geometry.clothoid.stations。
既存レイアウトのビューを編集layout.view。追加・位置/尺度/方向/範囲の更新・削除。cad_queryのlayoutViewsで編集対象を確認。
断面平面・ライブ断面・断面2Dsection.planeで位置・向き・反転・ライブ表示を設定。section.generateで断面図を生成。cad_queryのsectionPlanesで状態を確認。
アニメーションanimation.view / drive / scheduleで設定し、animation.controlでplay/pause/resume/stop。cad_queryのanimationsで設定と再生状態を取得。
複数部品の解析analysis.assembly.contacts / mesh / solve。部品別材料と接合設定を指定。解析結果は全ページを取得。STD/Proが必要。

layoutViews・sectionPlanes・animationsのクエリはEntityIdsを空配列にします。ビュー番号・図形IDは最新revisionに対応するものを使用してください。具体的な入力例は各操作のコード例・JSON Schema、解析データの復元は実装例にあります。

自動処理と画面操作の区別

cad_launch_interactive_commandは、ユーザーがCAD画面で続けて操作するための入口です。queuedだけで「保存した」「穴を開けた」「解析が成功した」と判断してはいけません。自動処理にはcad_get_capabilitiesに掲載された構造化操作を優先します。Freeでは板金・解析の呼出しを拒否します。

ライセンス制限の応答

cad_get_capabilitiesのlicense.currentPlanに現在のプラン、各操作のavailableに利用可否が入ります。制限対象はunavailableCode=license_required、licenseRestrictionにfeature・operation・currentPlan・requiredPlans・retryable=falseを返します。cad_get_operation_schemaと対話コマンド一覧でも同じ条件を確認できます。実行時にも判定し、計算ジョブは確定時にも再判定します。

{
  "code": "license_required",
  "message": "このAPIには有効なSTDまたはProライセンスが必要です。",
  "licenseRestriction": {
    "feature": "sheetmetal", "operation": "sheet.loft",
    "currentPlan": "Free", "requiredPlans": ["STD", "Pro"],
    "retryable": false
  }
}

上記は応答形式の例です。MCPではisError=trueの本文にJSONで返します。AIは制限理由と必要なプランを利用者へ説明し、同じ要求を繰り返したり別APIで制限を回避したりせず、available=trueの操作を選び直します。図面は変更されません。通信切断の再試行と、ライセンス制限の拒否を区別してください。

上限と復旧

ローカル通信は1メッセージ1 MiBまで。図形一覧は最大1000件、面・辺とジョブ結果は最大256件ずつ取得します。巨大な解析入力や1フレームが大きい非定常熱結果はMCP転送の上限に達する場合があります。新しい名前の操作や任意の内部メソッドは実行できません。

通信断後は同じリクエスト・同じoperationIdで再試行します。新しいUUIDで盲目的に再実行すると、二重作図・二重加工になります。cad_undoは手動編集も含む直前の操作を取り消します。MCP操作だけに限定されません。

保存・書き出し

cad_get_file_formats → cad_save_document または cad_export_document → cad_get_file_operation。中止はcad_cancel_file_operation。completedで初めて完了です。failedはerrorを確認し、ファイル処理にcad_commit_jobは使いません。Freeで許可される形式はJDC/JSON/STLです。

MCPで図面を確認する

view.captureをcad_execute_operationから実行すると、現在のモデルまたは指定したレイアウトをPNGへ描画します。画面のスクリーンショットではなく、CADの描画経路で投影図・紙面の図形・寸法を出力します。図形、選択、revisionは変更しません。レイアウトを表示している状態でも利用できます。

{
  "operation": "view.capture",
  "parameters": {
    "filePath": "D:/Drawings/preview.png",
    "layoutName": "板金1_展開図",
    "width": 2100,
    "height": 1485,
    "overwrite": false
  }
}

実際の要求には最新のdocumentId・expectedRevision・新しいoperationIdも指定します。layoutNameを省略するとモデルを出力します。PNGはCADを実行しているPCに保存されます。確認するクライアントで画像を開いてください。出力先は存在するフォルダーの絶対パス、画像サイズは幅320~4096・高さ240~4096です。既存ファイルを置き換える場合だけoverwriteをtrueにします。

cad_queryのkind=layoutsでレイアウト一覧、kind=sheetDefaultsで現在の板金設定を取得できます。layout.createはモデルの投影図、紙面の図形、実寸値の寸法を一括作成し、1回のUndoで戻せます。layout.activateでレイアウトを切り替えます。曲げフランジの一部区間はsheet.flangeのstartDistance・endDistanceで指定します。入力詳細は各操作のスキーマを取得してください。

注釈と寸法の作図ルール

R、穴数、長穴、面取りなどの注記は、原則として文字付き引き出し線を使用します。独立した文字と線に分けず、文字・矢印・折れ点を一体の編集可能な注釈にします。cad_queryのkind=layoutAnnotationsで紙面の要素番号を取得し、同じrevisionでlayout.annotationsを呼び出すと、指定注釈の置き換えや追加ができます。Textは本文、Anchorは矢印先端、Landingは文字を載せる水平線の起点、Elbowsは途中の折れ点です。寸法・モデル・投影図はそのまま保持します。

円や円弧の位置・ピッチを表す寸法は、その意図に応じて正確な中心を基準にします。投影した数値が同じでも、中心の代わりに接点を選ばないようにします。全長・接線・端面寸法は元図面の指定に従います。ユーザーが維持を指示した寸法は変更しません。確認にはview.captureを使用します。

図面を開く・モデルとレイアウトを切り替える

cad_get_capabilitiesとcad_get_operation_schemaで操作を確認し、既存のcad_execute_operationから実行できます。MCP接続の追加設定は不要です。

通常は最新のdocumentId・expectedRevisionと新しいoperationIdを指定します。ホーム画面で図面を開いていない場合だけ、documentIdを空文字列、expectedRevisionを0にします。未保存の変更がある場合はunsaved_changesで拒否されます。先にcad_save_documentを実行し、completedを確認してください。読み込み中に編集・別図面への切り替えがあった場合も、その図面を保護して切り替えを中止します。通信タイムアウト後は同じ要求・同じoperationIdで再試行します。重複して開き直しません。成功した応答のdocumentを取得し直し、以前の図形IDを再利用しないでください。

面へ文字・画像を貼り付ける

注釈ボタン(引き出し線などのプルダウン)で「面にラベル貼付け」を選び、モデルの面をクリックします。文字または画像を指定し、幅・高さ・回転・中心位置をプレビューで調整して確定します。「対象ラベル」から貼付け済みラベルを選び、「操作」を編集または削除に切り替え、右上の[✓]で確定します。面選択や設定変更だけでは確定しません。フォントは現在の図面の文字フォントを初期表示し、一覧から変更できます。削除しても立体は残り、Undoでラベルを戻せます。コマンドIDは MenuId.Constr.SurfaceLabel です。

平面、円筒、球面、自由曲面に対応します。同一曲面の連続した面や円筒の継ぎ目をまたいで表示し、実際の面端と穴では切り抜きます。幅・高さは中心位置の接平面を基準とするため、球面・自由曲面では端にゆがみが出ることがあります。特異点の中心や一周以上を覆う指定は使用できません。

元の立体形状・体積は変更しません。ラベル画像はJDCへ埋め込まれ、元画像ファイルがなくても表示でき、移動・コピーに追従します。印刷とPNG出力に含まれます。STEP/STLには文字や画像の見た目を出力しません。

MCPでは face.label を cad_execute_operation で実行します。最新のトポロジーから取得した face(entityId・revision・kind="face"・index)とWCSの center、mm単位の width・height、度単位の rotationDegrees、text または絶対パスの imagePath を渡します。文字は fontName と6桁RGBの color も指定できます。

cad_query の kind="surfaceLabels" に対象のentityIds(1~100件)を渡すと面参照、ラベルID、配置を取得できます。既定の mode="add" は追加、replace/remove は labelId を指定して編集/削除します。接続面への表示も1回のUndoで戻せます。実行前に cad_get_operation_schema で入力形式を確認してください。

入力・選択と仮表示

cad_start_inputで開始し、cad_get_inputでユーザーの確定を待ちます。cad_cancel_inputは中止、cad_update_input_previewは仮表示更新、cad_select_regionは範囲選択です。waitingやCursorPointは確定結果ではありません。

C#/VB.NETの使い方