Skip to main content

MCPツールとリソース

ツールはでアクションを実行します CODESYS 投影またはデバイス上で結果を返します。読書ツールはプロジェクトやデバイスには影響しません。ライティングツールはプロジェクトの内容や構造を永久に変えるため、表にはそれに応じたマークが付けられています。

開発ツール

開発ツール編集 CODESYS コントローラーとの接続を確立せずにプロジェクトを行う。

開発ツールは次のタスクに使用されます。

  • 構造化テキストでのプログラミング

  • プロジェクト構造とライブラリの管理

  • プロジェクトの確認

ツール

[説明]

エフェクト

add_or_remove_library

ライブラリ参照をプロジェクトに追加または削除します。

ライブラリマネージャーのライブラリ参照の変更

add_or_remove_program_call_in_task

プログラムをタスクに割り当てて、実行時サイクルで実行されるようにします。このツールは、新しいプログラムが作成された後に使用されます

このツールは、タスクからプログラム呼び出しを削除することもできます。

タスクのプログラムコールの変更

browse_project_tree

プロジェクトツリーまたは特定のサブツリーの構造を表示します。メソッド、プロパティ、アクションはオプションで親 POU の下に表示されます

読み取り専用

check_for_errors

プロジェクトにエラーがないかチェックし、ソースパスと行番号を含む診断メッセージを返します。標準モードでは、ツールはプリコンパイルルールを参照します。オプションで、フルコンパイルをトリガーできます。

読み取り専用。オプションで、ツールはプロジェクトのコンパイルをトリガーできます

create_folder

プロジェクトツリーに新しいフォルダを作成します。このツールを使うと、POU を論理的なグループにまとめることができます

新しいフォルダがプロジェクト内に作成されます。

create_or_replace_structured_text_object

新しい構造化テキストオブジェクトを作成するか、既存の構造化テキストオブジェクトを完全に書き換えます。ネストされたサブ POU を含む完全な POU を 1 回の呼び出しで作成できます。明示的に含まれていないサブPOUは保持されます

同じパスにある既存のオブジェクトは上書きされます。

get_active_app_as_path

現在ロードされているプロジェクトのパスを返します。

読み取り専用

get_active_path_and_selection

内のアクティブセレクションのパスを返します CODESYS。コードを選択すると、行番号と選択したテキストも返されます。

読み取り専用

get_available_libraries_list

で利用できるすべてのライブラリのリストを返します CODESYS。

読み取り専用

get_detailed_library_documentation

ライブラリの特定の機能に関する詳細なドキュメントを返します。パラメーター、戻り値の型、その他の関連情報が含まれます。

読み取り専用

get_library_documentation

ライブラリの内容の概要を簡潔に示します。すべての関数、型、およびそれらの最上位シグネチャが含まれています

読み取り専用

get_libraries_referenced_in_application

アプリケーションで参照されているすべてのライブラリのリストを返します。

読み取り専用

get_structured_text_content

指定されたパスにあるオブジェクトの構造化テキストソースコードを返します。ネストされたサブオブジェクト (メソッド、アクション、プロパティ、トランジションなど) はデフォルトで出力に含まれます

開始行と終了行を使用することによる出力の制限にも対応

読み取り専用

remove_object

プロジェクトからオブジェクトを削除します。このツールを使用して、ファンクションブロックから下位 POU を個別に削除することもできます

オブジェクトは取り消し不能に削除されます。

rename_object

オブジェクトの名前を変更し、そのオブジェクトへのすべての参照を更新します。リファレンスを調整できない場合、名前の変更は行われません。

すべての参照を変更して名前を完全に変更

replace_text_in_structured_text

構造化テキストオブジェクトでターゲットを絞ったテキスト置換を実行します。

指定したテキストがターゲットオブジェクトで置き換えられます。

search_in_files_by_regex

プロジェクトコード全体でテキストパターンを検索します。一致するものが返され、行番号付きのオブジェクトパスごとにグループ化されます

読み取り専用

search_libraries_for_type

使用可能なすべてのライブラリでタイプまたは関数を名前で検索します。ライブラリ名と要素タイプを返します。

読み取り専用

search_path_by_glob

グロブパターンを使用してプロジェクトツリー内のオブジェクトを検索します。祖先が共通する結果が多数ある場合、出力はグループで表示されます

読み取り専用

デバイスツール

デバイスツールは、CODESYSプロジェクトのデバイスツリーを編集し、デバイスリポジトリを管理します。

デバイスツールは次のタスクに使用されます。

  • デバイスのスキャン、追加、交換、構成

  • I/O チャネルへの変数のマッピング

  • デバイスリポジトリ内のデバイス説明の管理

デバイスツールはコントローラとの接続を確立しません。変更された設定は、次回のダウンロードまたはオンラインでの変更時にのみコントローラーに反映されます。

ツール

[説明]

エフェクト

acknowledge_device_diagnosis

コントローラ上のデバイスの診断メッセージを確認します。オプションで、ツールはすべての下位デバイスの診断メッセージも認識します。このツールは以下に対応します サブツリーの確認診断、確認診断 のコマンド。アプリケーションはオンラインモードでなければなりません

書き込み。コントローラ上のデバイスの確認パラメータに値を書き込みます。デバイスドライバは、デバイスの応答方法を決定します。

add_device

デバイスリポジトリからデバイスツリーにデバイスを追加します。ツールはデバイスを最上位のデバイスとして追加するか、デバイスまたはコネクタの下に追加します。たとえば、最上位のデバイスはコントローラーです。スロットの場合 プラグ・デバイス が使用されています。

書き込み。プロジェクトにデバイスを追加します。コントローラーのアプリケーションがオンラインモードの場合、ツールは使用できません。

copy_scanned_devices

マスター、スキャナー、またはコントローラーの下にあるフィールドバス上のデバイスをスキャンし、デバイスをプロジェクトに追加します。このツールは以下に対応します [デバイスをスキャン] コマンドイン CODESYS 次に、デバイスをプロジェクトにコピーします。デバイスが選択されていない場合、ツールはデバイスの説明がインストールされているすべての応答デバイスを追加します。ID によってデバイスを割り当てるフィールドバスの場合、ツールは次の結果から個々のデバイスも追加します scan_for_devices。

書き込み。プロジェクトを変更します。位置によってデバイスを割り当てるフィールドバスの場合、ツールはマスターの下にある既存の構成のみを replace_devices パラメーター。この場合、ツールはスキャンで見つからなかったデバイスを削除します。どのデバイスも応答しない場合、ツールは何も変更しません

enable_or_disable_device

デバイス、モジュール、または接続されたスロットを有効または無効にします。このツールは CODESYS のおよびコマンドに対応しています。

書き込み。プロジェクト内のデバイスを変更します。デバイスを無効にすると、その下位デバイスも無効になります。コントローラーのアプリケーションがログインしている間は、ツールを実行できません

get_device_online_status

デバイスとすべての下位デバイスのオンラインステータスを読み取ります。オンラインステータスは、デバイスツリーのステータスアイコンに対応しています。次に例を示します

  • 実行中

  • 警告

  • [エラー]

  • ライセンスなし

  • 診断

  • 無効

と include_diagnosis パラメーターを指定すると、ツールは診断メッセージや統計情報など、デバイスのステータスページから診断も読み取ります。このツールは、アプリケーションがオンラインモードのときのみステータスを読み取ります。

読み取り専用。

install_device_descriptions

たとえば、デバイス記述ファイルをデバイスリポジトリにインストールします。 devdesc.xml、ESI、EDS、GSDML、および IODD。このツールは、1 回の呼び出しで最大 20 個のファイルをインストールします。

書き込み。インストールのデバイスリポジトリを変更します。既存の説明を同じバージョンで上書きします

list_device_identifications

すべてのデバイス、コネクタ、およびスロットを、デバイスの説明のタイプ、ID、バージョン、モジュール ID とともに一覧表示します。このツールを使用して、構成を再現したり、使用されているリビジョンを確認したりします

読み取り専用。

list_io_channels

デバイスの I/O チャネルを、データ型とマップされた変数とともに一覧表示します。出力はデバイスエディターのページに対応します

読み取り専用。

map_variables_to_io_channels

変数を I/O チャネルにマップするか、マッピングを削除します。1 回の呼び出しで複数のデバイスを処理することもできます。ツールはすべてのエントリを事前にチェックします。

書き込み。前のマッピングを置き換えます。ツールがエントリを拒否しても、プロジェクトは変更されません

plug_device

デバイスを空のスロットまたはポートに接続します。たとえば、ツールはモジュールをバスカプラに差し込んだり、デバイスを IO-Link ポートに差し込んだりします

書き込み。デバイスがプロジェクトに接続されている。コントローラーのアプリケーションがオンラインモードの場合、ツールは使用できません

read_device_parameters

、デフォルト値、データタイプ、アクセスを使用してデバイスのパラメータを読み取ります。出力は、オフラインモードのデバイスエディターのパラメーターページに対応します。

読み取り専用。このツールはオンライン値を読み取りません。

scan_for_devices

マスター、コントローラー、またはスキャナーの下のフィールドバスに接続されているデバイスをスキャンします。コントローラーにアクセスできなければなりません。ほとんどのフィールドバスでは、フィールドバス構成のアプリケーションも実行中である必要があります

読み取り専用。既存のデバイスは保持されます。このツールには、同じネットワーク上の別のマシンのデバイスを含め、すべての応答デバイスが含まれます。そのため、結果を確認してください。 CODESYS スキャン中はブロックされます。通常、スキャンには数秒かかります。コントローラが応答しない場合、スキャンには約 20 秒。

copy_scanned_devices

このツールは、以下で見つかったデバイスを追加します scan_for_devices まだプロジェクトへのプロジェクトには含まれていません。コントローラーにアクセスできる必要があります。ほとんどのフィールドバスでは、フィールドバス構成のアプリケーションも実行中である必要があります

書き込み。見つかったデバイスをプロジェクトに追加します。既存のデバイスは保持されます。このツールは、応答するデバイスをすべて追加します

search_device_catalogue

正規表現を使用して、インストールされているデバイスの説明を名前、ベンダー、注文番号で検索します。ツールはオプションで、特定のデバイスの下またはスロットに収まるデバイスに検索を制限します

読み取り専用。

uninstall_device_descriptions

デバイスリポジトリからデバイスの説明を取り消し不能にアンインストールします。ツールはそれに依存する説明もアンインストールします

書き込み。アンインストールは取り消すことができず、現在開いているプロジェクトを含むすべてのプロジェクトに影響します。このツールは、開いているプロジェクトをチェックしません。その後、これらのプロジェクト内のデバイスには説明がなくなります。

unplug_device

デバイスをスロットまたはポートから削除します。スロットはデバイスツリーでは空のままです。

書き込み。デバイスとすべての下位要素を削除します

update_device

デバイスのデバイス説明を置き換えます。このツールは CODESYS のコマンドに対応しています。説明が指定されていない場合、ツールはインストールされている最新バージョンを使用します

書き込み。デバイスには名前と位置が保持されます。可能な場合は、デバイスのサブノードと設定も保持されます

write_device_parameters

プロジェクト内のデバイスパラメータの値を変更します。このツールは、デバイスエディターと同じ方法で値をチェックします。

書き込み。プロジェクトのみを変更します。コントローラーのアプリケーションがログインしている間は、ツールを実行できません。

オンラインツール

実際のハードウェアでは、オンラインツールは物理プラントのアプリケーションに基づいて機能します。オンラインツールを読んでも、アプリケーションやデバイスには影響しません。オンラインツールを作成すると、アプリケーションやデバイスの状態が変わります。

注意

以下のセキュリティ機能を使用して、AI アシスタントの意図しない動作からコントローラーを保護してください。

  • 確認済みのオンラインモード: デバイスで確認済みオンラインモードが有効になっている場合、次のツールは何も実行せず、エラーを報告します。

    • logout_application

    • reset_application

    • set_online_values

    • start_application

    • stop_application

    • execute_single_cycle_or_step

  • PLC ユーザー管理: PLC-UserManagement では、誰がどのアクションを実行できるかを詳細に定義できます。コントローラーで、AI アシスタントに必要な権限のみを持つユーザーを作成します。このユーザーとしてデバイスにログインします。

  • オペレーティングモード: 操作モードは通常、誤って実行されたツールなど、意図しないアクセスからコントローラーを保護します。

ツール

[説明]

エフェクト

execute_single_cycle_or_step

ログインしているアプリケーションの 1 サイクルまたは 1 ステップを実行してから停止します。

書き込み。コントローラーは入力を読み込み、プログラムを実行し、出力を書き込みます。この過程で、マシンが動くことがあります

get_application_state

アプリケーションがログインしているかどうかを返します。このツールは、アプリケーションが実行中か、停止しているか、ブレークポイントで停止しているかも返します

読み取り専用。

get_device_log

デバイスのランタイムログを読み取ります。オンライン操作が失敗した場合は、ログに原因が記録されます。

読み取り専用。

get_online_values

ログインしているアプリケーションの変数の現在の値を読み取ります。

読み取り専用。

list_forced_values

ログインしているアプリケーションの強制変数をすべて一覧表示します。

読み取り専用。

login_and_update_application_if_needed

ユーザーをデバイス上のアプリケーションにログインさせます。必要に応じて、ツールはプロジェクトをコンパイルし、デバイスにダウンロードします

書き込み。デバイスへの接続を確立し、必要に応じてデバイスにコードをダウンロードします

login_application_if_unchanged

アプリケーションが変更されていない場合は、ユーザーをデバイス上のアプリケーションにログインさせます。このログイン方法は注意が必要で、プロジェクトの変更をデバイスに転送しません

警告

それ以降にツールを呼び出すと、ログイン中のアプリケーションがリセットされたり、個々の変数が書き込まれて強制されたりすることがあります。

書き込み。ツールはアプリケーションをコンパイルして、デバイス上のアプリケーションと比較します。デバイス上のアプリケーションは変更されません

logout_application

ユーザーをアプリケーションからログアウトします。オプションで、ツールは最初に変数を強制します

書き込み。オンライン接続を終了します

reset_application

アプリケーションをリセットします。使用できるタイプは、ウォーム、コールド、オリジンです

書き込み。プログラムの実行を停止し、変数値をリセットします。原点にリセットすると、ツールはコントローラー上のアプリケーションを削除します

set_online_values

変数値を書き込んだり、強制したり、強制したりします。

書き込み。強制はセッション終了後も持続します

start_application

指定されたアプリケーションを起動します。アプリケーションはログインしている必要があります。まず、以下のコマンドでアプリケーションにログインします login_application_if_unchanged または login_and_update_application_if_needed。アプリケーションがログインしていない場合、ツールはエラーを報告します。アプリケーションがすでに実行中の場合、ツールは何も変更しません。

書き込み。ターゲットデバイス上でコードを実行します。実際のハードウェアでは、コードは物理プラント上で実行されます

stop_application

指定されたアプリケーションを停止します。アプリケーションはログインしている必要があります。まず、以下のコマンドでアプリケーションにログインします login_application_if_unchanged または login_and_update_application_if_needed。アプリケーションがログインしていない場合、ツールはエラーを報告します。アプリケーションが既に停止している場合、ツールは何も変更しません。

書き込み。ターゲットデバイス上のコードを停止します。

プロジェクト管理ツール

プロジェクト管理ツールを開く、保存する、閉じる CODESYS プロジェクトを作成し、プロジェクトステータスを返します。一度に開くことができるプロジェクトは 1 つだけです。プロジェクト管理ツールを読んでも、プロジェクトには影響しません。プロジェクト管理ツールを作成すると、開いているプロジェクトまたはプロジェクトファイルが変更されます。

重要

プロジェクト管理ツールには次のアクセス制限が適用されます。

  • ディレクトリホワイトリスト: このツールは、ユーザーが承認したフォルダー内のプロジェクトファイルのみで動作します。 ツール → オプション → MCP サーバー → ファイルアクセス。インストール後、フォルダは承認されません。インストールフォルダー、リポジトリフォルダー、Windows フォルダーは常にブロックされます。

  • ユーザー管理: の権利 CODESYS ユーザー管理はツールにも適用されます。ログインしたユーザーにコマンドの権限がない場合、ツールはコマンドを実行せず、エラーを報告します

ツール

[説明]

エフェクト

close_project

開いているプロジェクトを閉じます。プロジェクトに保存されていない変更が含まれている場合、ツールはエラーを報告します。 discard_changes パラメーターを指定すると、ツールは変更を破棄してプロジェクトを閉じます。

書き込み。 discard_changes、保存されていない変更は失われます。

get_project_status

開いているプロジェクトのステータスを返します。ステータスには、ファイルパス、プロジェクトタイプ、未保存の変更、および書き込み禁止が含まれます。オプションで、ツールはプロジェクト情報も返します

読み取り専用。

open_project

プロジェクト、ライブラリ、または FBS プロジェクトを開きます。オプションで、ツールはプロジェクトを読み取り専用として開きます

書き込み。プロジェクトをロードします。大規模なプロジェクトでは、開くまでに数分かかることがあります。

save_project

開いているプロジェクトをその保存場所に保存します。

書き込み。プロジェクトファイルを上書きします

save_project_as

開いているプロジェクトを新しいパスに保存します。新しいプロジェクトは開いたままです。

書き込み。新しいファイルを作成します。 overwrite パラメーターを指定すると、ツールは既存のファイルを上書きします。元のファイルは変更されません

リソース

リソースは、テンプレートや構文参照などの読み取り専用のコンテキストデータです。ツールとは異なり、リソースはアクションを実行しませんが、静的なコンテンツを提供します。リソースはプロンプトで直接参照できます。たとえば、「テストケーステンプレートに従ってテストケースを作成する」

資源

[説明]

CODESYS 構造化テキスト方言の説明

の方言のシンタックスリファレンス CODESYS IEC 61131-3 規格の説明と例が記載された ST と CODESYS-固有の拡張機能。このリファレンスには、構文規則、データ型とリテラル、変数セクション、演算子、制御フロー、呼び出し規約、インターフェイス、継承、および一般的なエラーの原因が含まれます。このリソースは、コード生成時やコードチェック時に使用することで、方言特有の特性による構文エラーを回避できます

CODESYS IEC ユニットテストテストケーステンプレート

パターンに従ったテストケーステンプレート TM.Testcase。このテンプレートには以下のメソッドが含まれています

  • Setup: テストオブジェクトの準備

  • Execute: 刺激テストと結果テスト

  • Teardown: テスト終了後のクリーンアップ

  • Abort: 実行中のテストのキャンセル処理

このリソースは、新しい単体テストを作成するときに使用されます。これにより、推奨パターンに従ってテストケースが生成されます CODESYS Test Manager.