KeyShot MCP について
KeyShot MCPは、ヘッドレススクリプトを介してAIエージェントが保存済みのKeyShotシーンを確認・変更し、プレビューやシーンコピーのレンダリングを行うMCPサーバーです。最終出力前に変更を確認する製品レンダリング向けで、起動中のGUIは操作しません。
主な機能
- 01保存済みシーンと詳細の確認
- 02指定したマテリアル、カメラ、環境の調整
- 03最終レンダリング前のプレビュー画像作成
- 04シーンコピー、カメラ一括、キューのレンダリング
- 05モデルの読み込みと準備済みシーンコピーの保存
活用シーン
- 01製品画像の書き出し前に構図やマテリアルを確認
- 02他のオブジェクトを保ちながらマテリアルを比較
- 03複数カメラから保存済みシーンをレンダリング
- 04レンダリングせずにモデルとシーンコピーを準備
MCP 対応
KeyShot MCPは、シーン確認、マテリアルやカメラの変更、プレビュー、読み込み、レンダリング用のツールを公開するMCPサーバーです。MCPプロンプトとリソースも提供します。
設定
ローカルサーバーの設定はどのクライアントでも共通です。コピーしてクライアントの MCP 設定ファイルに貼り付けてください。
npx -y keyshot-mcpKEYSHOT_HEADLESS_EXEシークレットAbsolute path to KeyShot headless, or a command available on PATH.KEYSHOT_OUTPUT_DIRシークレットRoot directory for rendered images and saved scenes.KEYSHOT_ALLOW_EXTERNAL_OUTPUTSシークレットSet to true only when output paths outside KEYSHOT_OUTPUT_DIR are required.KEYSHOT_TIMEOUT_MSシークレットTimeout in milliseconds for one KeyShot headless process.KEYSHOT_LICENSE_ARGSシークレットOptional additional KeyShot launch arguments.KEYSHOT_MATERIAL_PRESETSシークレットOptional path to a user-managed material preset JSON file.KEYSHOT_CAMERA_PRESETSシークレットOptional path to a user-managed camera preset JSON file.ローカルサーバーにはマシン上の実行環境(Node.js 18 以上など)が必要です。設定ファイルの場所はクライアントごとに異なります。
ツール
19掲載時のツール一覧 · 1 週間前に更新
このツールにパラメーターはありません。
詳細
AI エージェントのガイドで、KeyShot の製品レンダリングを行えます。
AI エージェントの支援で、KeyShot の製品レンダリングを行えます。
保存済みのシーンを確認し、指定したマテリアルとカメラを調整して、プレビューを確認してからシーンのコピーをレンダリングできます。
保存済みのシーンを確認し、指定したオブジェクトのマテリアルとカメラを調整して、プレビューを確認してからコピーから出力できます。
英語 · 簡体字中国語
仕組み/使用手順 ·
デモ/実際の動作 ·
クイックスタート ·
ワークフロー ·
ツール ·
中国語版のインストール
KeyShot のワークフローに役立ちましたか?リポジトリに Star を付けて、ほかのデザイナーにもこのプロジェクトを知らせましょう。
KeyShot のワークフローが改善したら、ぜひ Star を付けて、ほかのデザイナーにもこのプロジェクトを知ってもらいましょう。
重要
保存済みのシーンが対象で、GUI をリアルタイムに操作するものではありません。 KeyShot MCP は KeyShot と同じ コンピューター上でヘッドレス実行されます。未保存の編集内容を読み取ったり、開いている KeyShot ウィンドウを操作したりすることはできません。 保存済みのシーンが対象で、GUI をリアルタイムに操作するものではありません。 サーバーはローカルで KeyShot をバックグラウンド実行するため、ウィンドウ上の未保存の変更内容は読み取れません。
クライアントエージェントとプライバシー。 MCP クライアントのエージェントは、ツールから返されるシーン情報とプレビューを受け取ります。 クライアントの実装や設定によっては、これらの結果が設定済みのモデルプロバイダーに送信される場合があります。KeyShot MCP 自体が これらをアップロードすることはありません。機密性の高い作業を行う前に、プライバシーとセキュリティをご確認ください。
クライアントエージェントとプライバシー。 MCP クライアント内のエージェントは、ツールから返されるシーン情報とプレビューを受け取ります。 クライアントの実装や設定によっては、これらの内容が選択されたモデルサービスに送信される場合があります。KeyShot MCP 自体がこれらの内容を積極的にアップロードすることはありません。 機密プロジェクトでは、事前にプライバシーとセキュリティに関する説明をお読みください。
リクエストからレンダリングまで
セットアップ後、エージェントに変更内容を伝えます。KeyShot MCP が保存済みシーンのコピー上で作業を行い、最終出力の前にプレビューを確認できます。
「ランタンの金属をブラッシュドスチールに変更し、ガラスはそのままにして、プレビューを見せてください。承認したら、画像とシーンのコピーを書き出してください。」
「把灯具的金属换成拉丝钢,玻璃保持不变,先给我看预览。确认后输出图片和场景副本。」
プレビューに満足できない場合は、書き出す前に別の調整を依頼できます。元のシーンは上書きされず、最終ファイルは設定済みの出力ディレクトリに保存されます。
製品デモ
真鍮の外観 · ブラッシュドスチールの外観
1 つのオブジェクトに 2 種類の仕上げ。 どちらの画像も、同じカメラと環境を使い、KeyShot 14.1 で 1440 × 1080、64 samples の設定でレンダリングしました。比較の前にガラスを明示的に修正し、画像間で変更したのは金属だけです。
同じオブジェクトに 2 種類のマテリアル案。 2 枚の画像は、同じカメラと環境を使い、KeyShot 14.1 で 1440 × 1080、64 samples の設定で実際に生成しました。インポートしたガラスを先に修正し、金属オブジェクトだけを置き換えて、ガラスはそのままにしています。
モデル:Lantern 01(Rajil Jose Macatangay 作)、 Poly Haven 提供、CC0 ライセンス。 これらはローカルの KeyShot でレンダリングした画像であり、Poly Haven ウェブサイトのプレビューではありません。 モデルの出典、作者、CC0 ライセンスは上記のとおりです。掲載画像はローカルでレンダリングしたもので、ウェブサイトの公式プレビュー画像ではありません。
English
できること
- 製品画像を準備する: モデルをインポートするかシーンを開き、選択したマテリアル、カメラ、環境を設定して、1 つの KeyShot プロセス内でコピーを保存し、レンダリングします。
- 最終出力の前に確認する: PNG をエージェントに返し、構図、マテリアル、ライティングについてフィードバックを受けます。デザイン上の判断はユーザーが行います。
- 保存状態から続ける: 保存済みの
.bipの変更を検出してシーンをコピーし、アクティブな GUI セッションを読み取ることなくプレビューします。 - 複数のビューをレンダリングする: 保存済みのすべてのカメラを検出し、特定のカメラを選択するか、異なるシーンをキューに入れて順番にレンダリングします。
クイックスタート
要件: Node.js 20 以降、MCP 対応クライアント、およびヘッドレススクリプティングに対応した、ライセンス取得済みの KeyShot エディションがローカルにインストールされていること。Windows 11 + KeyShot Studio 2025 / KeyShot 14.1 でテスト済みです。 その他のシステムと KeyShot のバージョンは検証されていません。 KeyShot ソフトウェア、ライセンス、ライブラリアセットは含まれていません。
バージョン 0.13.5。 このメンテナンスリリースでは、出力保護、プレビューのサイズ制限、公開時のプライバシー、Windows のインストールパス、起動時の診断機能を強化しました。以下のインストール例はこのバージョンを対象としています。リリース検証記録と 1.0 チェックリストを参照してください。 変更履歴とアップグレードに関する注意事項も参照してください。
エージェントにインストールを依頼する
クライアントの MCP 設定を編集できるエージェントに、次の内容を送信してください:
Install KeyShot MCP 0.13.5 in my MCP client using npx -y [email protected].
Find the full path of my local keyshot_headless.exe and set KEYSHOT_HEADLESS_EXE.
Keep the default Documents/KeyShot MCP Outputs folder and external outputs disabled.
Use my client's configuration format, restart or reload it, and run keyshot_status.
Explain failed checks in plain language. Do not request or upload license keys.
Do not upload or publish my scenes or retained render files.
Before showing confidential scene metadata or previews to a model service, ask me first.
自分で設定する
これは汎用的な mcpServers JSON の例です。クライアントの設定形式を使用し、
実行ファイルのパスをお使いのコンピューター上の実際のパスに置き換えてください。
{
"mcpServers": {
"keyshot": {
"command": "npx",
"args": ["-y", "[email protected]"],
"env": {
"KEYSHOT_HEADLESS_EXE": "C:/Program Files/KeyShot Studio/bin/keyshot_headless.exe"
}
}
}
}
クライアントを再起動し、keyshot_status を実行して、ready: true が表示されることを確認します。これにより、
実行ファイル、出力へのアクセス、ブリッジ、プリセット、および最小限の KeyShot の起動を確認できます。
グローバル npm インストールまたはソースからのビルド
グローバル: npm install -g [email protected] を実行し、クライアントコマンドとして
keyshot-mcp を使用します。npx の引数は不要です。同じ環境設定を維持してください。
ソース:
git clone https://github.com/truman-t3/keyshot-mcp.git
cd keyshot-mcp
pnpm install --frozen-lockfile
pnpm run build
コマンドとして node を使用し、引数には dist/index.js の絶対パスを指定します。
チェックアウトしたソースは npm 版より新しい場合があります。クライアントの例は examples にあります。
ワークフロー
レンダリング前にプレビューする
Inspect C:\projects\speaker.bip and show a preview. Describe framing or material
problems, but wait for approval before editing or producing a final render.
推奨される順序:ステータスを確認 → 調査 → プレビュー → 相談 → 承認 → レンダリング。
keyshot_preview_render は PNG を埋め込み、読み取り後に一時ファイルを削除します。
画像を保存する必要がある場合にのみ、outputPath を指定してください。
製品をレンダリングする
Import C:\models\speaker.obj, center it and place it on the ground. Use Isometric,
save a scene copy and show a preview first. If the framing clips the model, propose
a camera adjustment before rendering the approved scene at standard quality.
keyshot_product_render は、1 つのモデルまたは 1 つの保存済みシーンを受け付けます。新しいモデルではデフォルトで
インポート時の構成オプションが使用されます。既存のシーンでは、変更を要求しない限り設定が維持されます。
未リリースの main では、ベースシーンのない新しいモデルに標準ビューカメラを使用する場合、
ワールド空間のシーン境界をレンダリングのアスペクト比に合わせ、端に 10% の余白を設けます。
距離を明示的に指定した場合、カメラ座標を絶対値で指定した場合、およびベースシーンを使用する場合は、
そのフレーミングが維持されます。これはメインの製品だけでなく、シーン内のすべてのジオメトリに適用されるため、
最終レンダリングの前にプレビューを確認してください。公開済みの 0.13.5 では、従来のフレーミングが維持されます。
1 つのオブジェクトでマテリアルを比較する
Inspect the saved scene and list material presets. Identify the metal object,
change only that object to Brushed Steel in a scene copy, keep the glass unchanged,
and show a preview before final rendering.
名前が重複する場合は、返された objectPath を使用してください。マテリアル名はローカルの
KeyShot ライブラリによって異なるため、推測で指定しないでください。マテリアルのルールを参照してください。
KeyShot で保存した後に続行する
I saved my scene in C:\projects\speaker. Sync the newest .bip in that folder,
show me a preview and do not overwrite the original.
keyshot_sync_saved_scene は、1 つのファイルまたは 1 つのプロジェクトフォルダーを受け付けます。後続の呼び出しでは
前回のフィンガープリントを再利用してください。変更のない保存では、再コピーや再レンダリングを行わずに
changed: false が返されます。これは明示的な同期であり、バックグラウンドでの自動監視ではありません。
すべてのカメラでレンダリングする
Render every saved camera in C:\scenes\speaker.bip at preview quality. Continue
if one camera fails, and do not overwrite existing images.
選択したカメラには keyshot_batch_render を、異なるシーンには keyshot_render_queue を使用してください。
レンダリングせずにモデルを準備する
Import C:\models\speaker.obj, center it, place it on the ground and adjust the
camera target and environment. Save a scene copy; do not render an image yet.
準備済みの .bip だけが必要な場合は、keyshot_import_model を使用してください。
レンズと環境を調整する
Set the Product Hero camera to a 55 mm focal length, rotate the current
environment to 45 degrees, save a scene copy and show a preview.
個別の変更には keyshot_set_camera と keyshot_set_environment を使用してください。
レンダリング品質
| プリセット | 解像度 | サンプル数 | 主な用途 |
|---|---|---|---|
preview | 960 × 540 | 16 | 構図とマテリアルの確認 |
standard | 1920 × 1080 | 64 | デフォルトの製品レンダリング品質 |
final | 3840 × 2160 | 256 | 高解像度の出力 |
明示的に指定した寸法とサンプル数は、プリセットより優先されます。maxTimeSeconds を指定すると
時間ベースのレンダリングに切り替わり、samples を明示的に指定することはできません。
fieldOfView と focalLength は同時に指定できません。カメラの position と
lookAt は、必ずセットで指定してください。品質プリセットを指定しても、最終的な見た目が保証されるわけではありません。
qualityPreset を省略した場合、低レベルのレンダリングツールでは従来のデフォルト値が使用されます。
ツールリファレンス
レビューと製品レンダリングから始めてください。その他のツールでは、対象を絞った制御を行えます。 すべてのパラメーターは生成されたカタログを参照してください。
| グループ | ツール |
|---|---|
| 診断とレビュー | keyshot_status, keyshot_inspect_scene, keyshot_preview_render, keyshot_sync_saved_scene |
| 製品ワークフロー | keyshot_product_render |
| インポートと保存 | keyshot_import_model, keyshot_save_scene |
| マテリアル | keyshot_list_material_presets, keyshot_apply_material_preset, keyshot_apply_material |
| カメラ | keyshot_list_cameras, keyshot_list_camera_presets, keyshot_apply_camera_preset, keyshot_set_camera |
| 環境 | keyshot_set_environment |
| レンダリング | keyshot_render, keyshot_batch_render, keyshot_render_all_cameras, keyshot_render_queue |
サーバーには、製品レンダリング用のMCPプロンプトとワークフロー用のMCPリソースも用意されています。 同梱のエージェントスキルでは、セットアップ、診断、安全なツールの選択について説明しています。これらは独立したインターフェースであり、追加のレンダリングツールではありません。
カメラとマテリアルのプリセット
同梱されているカメラプリセットは、Front、Back、Left、Right、Top、Bottom、Isometricです。
カスタムカメラJSONでは、standardViewまたは絶対位置のposition、lookAt、省略可能なupを指定できます。オブジェクト形式と配列形式の両方をサポートしています。プリセットファイルを参照してください。
マテリアルプリセットでは、同梱の独自マテリアルではなく、ローカルのKeyShotライブラリ名またはマテリアルファイルを参照します。サーバーはプリセットJSONを読み取るだけで、編集は行いません。
カスタムファイルにはKEYSHOT_CAMERA_PRESETSとKEYSHOT_MATERIAL_PRESETSを使用してください。
マテリアルの割り当てとエラーに関するガイダンスを参照してください。
設定と安全性
| 変数 | デフォルト | 目的 |
|---|---|---|
KEYSHOT_HEADLESS_EXE | Windows: keyshot_headless.exe | 実行ファイルのフルパス、またはPATH上のコマンド |
KEYSHOT_OUTPUT_DIR | <home>/Documents/KeyShot MCP Outputs | 許可される出力ルート |
KEYSHOT_ALLOW_EXTERNAL_OUTPUTS | false | 信頼できる外部出力パスを明示的に許可 |
KEYSHOT_TIMEOUT_MS | 600000 | プロセスごとのタイムアウト(ミリ秒) |
KEYSHOT_CAMERA_PRESETS | bundled JSON | カスタムカメラプリセット |
KEYSHOT_MATERIAL_PRESETS | bundled JSON | カスタムマテリアル参照 |
KEYSHOT_LICENSE_ARGS | empty | オプションの起動引数。診断情報に値は出力されません |
入力には、信頼できるローカルパスを使用できます。出力先のパストラバーサルやシンボリックリンク/ジャンクションによる逸脱は、デフォルトで拒否されます。自動命名される製品出力は、名前が重複した場合に-2、-3などを付けます。明示的に指定したパスの名前は、暗黙に変更されません。書き込みツールは、デフォルトで既存のファイルを拒否します。異なる出力を意図的に置き換える場合に限り、overwrite: trueを設定してください。この設定でも、このリクエストの入力シーン、モデル、マテリアル、環境を、リンクされたエイリアスを含めて置き換えることはできません。プレビューと保存済みシーンの同期では、上書きは行われません。シーンと画像の保存先は分けてください。シーンのコピーを推奨します。
KeyShotのヘッドレスタスクは、ライセンスやファイルの競合を減らすため、各サーバーインスタンス内で順番に実行されます。別々のMCPサーバープロセス間では連携しません。
処理はローカルで行われます。MCPクライアント内のエージェントがこれらのツールを使用する場合、クライアントの実装や設定によっては、ツールの結果、シーンのメタデータ、プレビュー画像が、選択したモデルプロバイダーに送信されることがあります。KeyShot MCP自体がこれらの結果をアップロードすることはありません。機密性の高い作業を行う前に、プライバシー設定を確認してください。ライセンスの回避機能や、任意のPythonコードの実行機能は提供されません。セキュリティを参照してください。
質問とサポート
開いているKeyShotウィンドウを編集できますか? いいえ。シーンを保存してから、コピーを同期してください。実験的なブリッジではScript Runnerがアクティブな状態に保たれ、操作がブロックされていました。安定版の製品には含まれていません。技術的な説明。
新しいMCPへの対応とは、ChatGPT EventsやGUIへの対応を意味しますか? いいえ。安定版のstdioサーバーは、2026-07-28と従来の2025-11-25クライアントに対応しています。認証済みのリモートEvents配信は別の機能であり、まだリリースされていません。アップグレードに関する注意事項を参照してください。
セットアップ、マテリアル、レンダリングに失敗した場合はどうすればよいですか? keyshot_statusを実行して、失敗したチェックと提案を確認し、ローカルのマテリアル名を検証して、小さなプレビューを試してください。ツールのエラーを、変更が完了したこととして扱わないでください。
ログを共有する前にサポートをお読みください。個人のシーン、顧客のモデル、認証情報、ライセンス情報、機密のレンダリング結果を公開しないでください。
開発とロードマップ
セットアップとチェックについては、コントリビューションをご覧ください。CI は Windows/Ubuntu と Node.js 20/24 を対象としています。Linux CI は、Linux での KeyShot のサポートを保証するものではありません。
生成されるキューブは、引き続き自動スモークテスト用のフィクスチャです。npm run smoke:keyshot は、サポート対象でライセンス済みのローカル KeyShot がインストールされている場合にのみ実行してください。
次の優先事項は、より多くの KeyShot リリースと macOS での実環境検証、および安定したヘッドレス API が利用可能になった際のレンズ制御の拡充です。GUI 制御には、永続的なブロッキングスクリプトではなく、サポート対象のノンブロッキング統合が必要です。
ライセンスと独立性
コードはMIT ライセンスです。サードパーティのデモアセットには、それぞれ独自のライセンスが適用されます。 KeyShot は KeyShot ApS および/または KeyShot Inc. の商標です。この独立したコミュニティプロジェクトは、KeyShot と提携、承認、後援関係にありません。KeyShot は別途インストールし、ライセンスを取得してください。プロプライエタリソフトウェアやアセットを再配布しないでください。 コミュニティでの行動規範については、行動規範をご覧ください。
中文
主な特長
- 要望をレンダリングワークフローに変換: 1 つのツールで、シーンのインポートまたはオープン、オブジェクトのマテリアル指定、カメラ、環境、コピーの保存、レンダリングまで行います。
- まずプレビューを確認してから決定: PNG をエージェントに直接返し、構図、マテリアル、ライティングについて話し合えます。デザイン上の判断に代わるものではありません。
- 保存済みファイルから作業を続行:
.bipの保存変更を検出してコピーを同期します。GUI で未保存の編集は読み取りません。 - 複数の視点を一度に出力: すべてのカメラを自動で読み取るほか、一部のカメラを選択したり、複数のシーンを順番に処理したりできます。
クイックスタート
Node.js 20+、MCP 対応クライアント、および headless スクリプトに対応した、合法的にライセンス取得済みの KeyShot がローカルにインストールされていることが必要です。Windows 11 + KeyShot Studio 2025 / KeyShot 14.1で実機検証済みです。その他のシステムと KeyShot バージョンは、まだ実機検証されていません。本プロジェクトに KeyShot、ライセンス、公式マテリアルライブラリは含まれません。
本バージョンは 0.13.5 です: 出力保護、プレビューサイズ制限、リリース時のプライバシー、Windows のインストールパス、起動時の診断を重点的に強化しました。以下のインストール例ではこのバージョンを使用します。
検証記録と正式リリースの準備についてはリリース準備チェックリスト、バージョン変更については変更履歴とアップグレードガイドをご覧ください。
インストールをエージェントに任せる
以下の文を、クライアントの MCP 設定を変更できるエージェントに送信してください:
请用 npx -y [email protected] 将 KeyShot MCP 安装到我的 MCP 客户端。
找到本机 keyshot_headless.exe 的完整路径,设置 KEYSHOT_HEADLESS_EXE。
保留默认“文档/KeyShot MCP Outputs”输出目录,关闭外部输出。
按这个客户端实际支持的格式配置,重启或重新加载后运行 keyshot_status。
用普通设计师能理解的语言解释失败检查,不索取或上传许可证密钥。
不要上传或发布我的场景或保留的渲染文件。
如果要把保密场景的元数据或预览发送给模型服务,请先取得我的确认。
手動設定
以下は汎用的な mcpServers JSON の例です。すべてのクライアントでこの形式をそのまま使用できるとは限りません。
実行ファイルのパスは、ローカル環境の実際のパスに置き換えてください。
{
"mcpServers": {
"keyshot": {
"command": "npx",
"args": ["-y", "[email protected]"],
"env": {
"KEYSHOT_HEADLESS_EXE": "C:/Program Files/KeyShot Studio/bin/keyshot_headless.exe"
}
}
}
}
クライアントを再起動し、keyshot_status を実行して ready: true であることを確認します。実行ファイル、出力ディレクトリの権限、bridge、プリセット、KeyShot の最小起動プロセスをチェックします。
グローバル npm インストールまたはソースからの実行
グローバルインストール: npm install -g [email protected] を実行し、クライアントのコマンドを keyshot-mcp に変更します。npx の引数は不要です。環境変数はそのまま使用します。
ソースからの実行:
git clone https://github.com/truman-t3/keyshot-mcp.git
cd keyshot-mcp
pnpm install --frozen-lockfile
pnpm run build
クライアントのコマンドには node を使用し、引数には dist/index.js の絶対パスを指定します。
これにより、現在チェックアウトしているソースを実行します。npm で公開済みのバージョンより新しい場合があります。例は examples にあります。
よく使うワークフロー
まずプレビューし、その後に本レンダリングを行う
检查 C:\projects\speaker.bip,给我看预览,说明构图或材质问题。
先不要修改,也不要直接输出最终渲染,等我确认。
推奨順序:ステータス確認 → シーン確認 → プレビュー → 相談 → 確認 → 本レンダリング。
keyshot_preview_render は PNG を返した後、一時ファイルを削除します。画像を保持する必要がある場合のみ outputPath を指定してください。
一言で製品レンダリングを準備する
导入 C:\models\speaker.obj,居中贴地,用 Isometric 视角,保存副本,先给我看预览。
如果画面裁切了模型,先提出相机调整建议;确认后再按标准质量渲染。
keyshot_product_render は、モデルまたは保存済みシーンを 1 つ受け付けます。新しいモデルでは、インポート時の構図オプションがデフォルトで有効になります。
既存のシーンでは、明確な指示がない限り、元の設定を維持します。未リリースの main では、基本シーンを使用しない新しいモデルの場合、標準ビューでワールド座標のバウンディングボックスと出力アスペクト比に基づいて構図を調整し、四辺に 10% の余白を確保します。距離の明示指定、絶対カメラ座標、基本シーンでは、元の構図を維持します。バウンディングボックスには主製品だけでなく、シーン内のすべてのジオメトリが含まれます。本レンダリングの前に、必ずプレビューを確認してください。リリース済みの 0.13.5 では、従来の構図ロジックを引き続き使用します。
1 つのオブジェクトのマテリアルだけを変更する
检查场景并列出材质预设,找出金属对象,只把这个对象改为 Brushed Steel。
保持玻璃不变,保存副本,先展示预览,不要直接输出最终图。
同名オブジェクトには、検査結果に含まれる objectPath を使用してください。マテリアル名はローカルのマテリアルライブラリに基づいて指定し、推測で入力しないでください。詳しいルールについてはマテリアル適用ガイドをご覧ください。
KeyShot で最後に保存した状態から続行する
我已把场景保存在 C:\projects\speaker。同步这个文件夹里最新的 .bip,
给我看预览,不要覆盖原场景。
keyshot_sync_saved_scene は、ファイルまたはプロジェクトフォルダーを 1 つ受け付けます。再度呼び出すと、前回の内容フィンガープリントを再利用します。新たな保存がない場合は changed: false を返し、コピーやレンダリングを重複して行いません。これは明示的な同期であり、自動バックグラウンド監視ではありません。
すべてのカメラをレンダリングする
用预览质量渲染 C:\scenes\speaker.bip 中全部已保存相机。
某个相机失败时继续,不要覆盖已有图片。
カメラを指定するには keyshot_batch_render を、異なるシーンには keyshot_render_queue を使用してください。
モデルを整理するだけで、レンダリングはしない
导入 C:\models\speaker.obj,居中贴地,调整相机观察点和环境。
保存场景副本,暂时不要渲染图片。
整理済みの .bip だけが必要な場合は、keyshot_import_model を使用してください。
レンズと環境を調整する
把 Product Hero 相机设为 55 mm 焦距,将当前环境旋转到 45 度,
保存场景副本并给我看预览。
カメラと環境の調整には、それぞれ keyshot_set_camera と keyshot_set_environment を使用してください。
レンダリング品質
| プリセット | 解像度 | サンプル数 | よく使う用途 |
|---|---|---|---|
preview | 960 × 540 | 16 | 構図、マテリアルの確認 |
standard | 1920 × 1080 | 64 | 製品レンダリングのデフォルト品質 |
final | 3840 × 2160 | 256 | 高解像度出力 |
幅、高さ、サンプル数を明示的に指定すると、プリセット値が上書きされます。maxTimeSeconds を指定すると時間制限付きレンダリングに切り替わり、明示的な samples と同時には使用できません。fieldOfView と focalLength は併用できません。position と lookAt は必ず両方指定してください。結果は必ず確認してください。品質プリセットは「最終的な仕上がりを保証する」ものではありません。
低レベルのレンダリングツールで qualityPreset を指定しない場合、それぞれの既存のデフォルト動作が維持されます。
ツールリファレンス
19 個のツールは、タスク別に上記のツール一覧に掲載されています。完全なパラメーター一覧は、コードから自動生成されるツールカタログをご覧ください。よく使うエントリーポイントは、keyshot_status、keyshot_inspect_scene、keyshot_preview_render、keyshot_sync_saved_scene、keyshot_product_render です。
製品レンダリング用のプロンプト、ワークフロー用リソース、エージェントスキルもあります。これらはワークフローを案内するもので、追加のレンダリングツールではありません。名称をすべて覚える必要はなく、デザインの要望をそのまま説明できます。
相机与材质预设
内置七个相机视角:Front、Back、Left、Right、Top、Bottom 和 Isometric。
自定义相机 JSON 可填写 standardView,或绝对坐标 position、lookAt 与可选 up;
支持对象和数组格式,参见预设文件。
材质预设引用本机 KeyShot 材质库名称或材质文件,不附带专有材质资源。
服务只读取预设 JSON,不自动修改。自定义文件分别通过 KEYSHOT_CAMERA_PRESETS
和 KEYSHOT_MATERIAL_PRESETS 配置,材质规则及错误处理见材质应用说明。
配置与安全
| 环境变量 | 默认值 | 用途 |
|---|---|---|
KEYSHOT_HEADLESS_EXE | Windows:keyshot_headless.exe | 实际可执行文件路径,或 PATH 中命令 |
KEYSHOT_OUTPUT_DIR | <用户目录>/Documents/KeyShot MCP Outputs | 允许的输出根目录 |
KEYSHOT_ALLOW_EXTERNAL_OUTPUTS | false | 显式允许可信的外部输出位置 |
KEYSHOT_TIMEOUT_MS | 600000 | 单次进程超时,单位毫秒 |
KEYSHOT_CAMERA_PRESETS | 内置 JSON | 自定义相机预设 |
KEYSHOT_MATERIAL_PRESETS | 内置 JSON | 自定义材质引用 |
KEYSHOT_LICENSE_ARGS | 空 | 可选启动参数,诊断不回显内容 |
输入可以来自任意可信本地路径。默认拒绝越界路径及软链接/目录联接逃逸。
产品工具自动命名的输出重名时使用 -2、-3 等编号,显式路径不被静默改名。
写入工具默认拒绝覆盖已有文件。只有确实要替换另一个输出文件时才设置
overwrite: true;即使开启,也不能覆盖本次调用的输入场景、模型、材质或环境文件,
包括指向它们的链接。预览与保存同步始终不覆盖。场景和图片必须使用不同路径,平时使用场景副本。
同一个服务实例内的 KeyShot 后台任务按顺序执行,以减少许可证和文件冲突;
多个独立 MCP 服务进程之间不共享这一排队机制。
处理在本机完成。MCP 客户端中的 Agent 使用工具时,返回的工具结果、场景元数据和 预览图可能根据客户端的实现与配置发送给所选模型服务。 KeyShot MCP 本身不主动上传 这些内容。保密项目请先核对隐私设置。项目不提供许可证绕过或任意 Python 执行。 更多说明见 SECURITY.md。
常见问题与支持
能控制正在打开的 KeyShot 窗口吗? 不能。先保存,再同步副本。实验 Bridge 会持续占用 Script Runner,阻挡正常操作,因此没有作为稳定功能发布。 完整原因见 GUI 能力边界。
支持新 MCP 协议,就能用 ChatGPT Events 或实时控制吗? 不能这样推断。
稳定 stdio 服务支持 2026-07-28 和旧 2025-11-25 客户端;远程鉴权与事件投递属于
尚未发布的独立集成,详见升级说明。
安装、材质或渲染失败怎么办? 先运行 keyshot_status,查看失败检查和建议,
核对本机材质名称,再尝试小尺寸预览。不要把报错当成已经完成修改。
- 使用与安装:Discussions。
- 可复现错误:Bug 报告。
- 工作流建议:功能建议。
- 安全漏洞:私密报告。
分享日志前请阅读 SUPPORT.md,不要公开客户模型、私有场景、凭据、许可证或保密渲染图。
开发与路线图
环境准备与完整测试命令见贡献指南。CI 覆盖 Windows/Ubuntu 和
Node.js 20/24;Linux CI 不代表 KeyShot 已在 Linux 上实机可用。原有立方体保留为
自动 smoke test 夹具,npm run smoke:keyshot 只在已安装并合法授权 KeyShot 的机器运行。
后续重点:更多 KeyShot 版本和 macOS 实机验证,以及稳定 headless API 可用时的镜头 控制。实时 GUI 需要受支持的非阻塞接入方式,不采用长期阻挡窗口的脚本。
许可与非官方说明
代码采用 MIT License,第三方演示资产保留自己的许可。KeyShot 是 KeyShot ApS 和/或 KeyShot Inc. 的商标。本项目是独立开源社区项目,与官方无隶属、 认可或赞助关系。用户需单独安装并合法授权 KeyShot,不重新分发其专有软件或素材。 社区协作遵循行为准则。
コメント
AI アプリケーションが外部のツールやデータソースに統一的な方法で接続するためのオープンなプロトコルです。クライアントはモデルとの対話を担い、MCP サーバーはツール・リソース・プロンプトテンプレートを提供します。標準メッセージでやり取りするため、1 つのサーバーを複数のクライアントで再利用できます。