UIP エージェント ツール

uip agent tool は、エージェント プロジェクトの ツール リソース を管理します。ツールとは、外部の動作に対するエージェントの呼び出しです。たとえば、Integration Service のコネクタ、Orchestrator のプロセス、他のエージェント、API ワークフロー、プロセス オーケストレーション フロー、IXP スキルです。エージェントのツール リソースの各エントリは、エージェントが呼び出すことができる 1 つのアクションに対応しています。

add動詞はローカルでディスクに書き込みます。discover と connect は Integration Service (IS) API を呼び出すため、アクティブな CLI セッション (uip login) が必要になります。list と remove は純粋にローカルです。

概要

uip agent tool add      <name> [--type <type>]
                               [--description <desc>]
                               [--connector <key>] [--connector-url <url>]
                               [--object-name <name>]
                               [--connection-id <id>]
                               [--method <method>]
                               [--process-name <name>] [--folder-path <path>]
                               [--path <dir>]
uip agent tool discover  --connector <key> [--connection-id <id>]
uip agent tool connect   <name> --connection-id <id> [--path <dir>]
uip agent tool list                                  [--path <dir>]
uip agent tool remove    <name>                      [--path <dir>]

すべてのサブコマンドは、 グローバルオプション (--output、 --output-filter、 --log-level、 --log-file) を優先します。終了コードは 標準コントラクトに従います。

有効なツールの種類は、 integration、 process、 agent、 apiWorkflow、 processOrchestration、 ixpです。

UIP エージェント ツールの追加

エージェントにツール リソースを追加します。

引数

• <name> (必須) — エージェントによって参照されるツール名。

オプション

フラグ	既定 (Default)	Required	目的
--type <type>	--connectorが存在する場合integrationそれ以外の場合は必須	条件	ツールの種類。integration、process、agent、apiWorkflow、processOrchestration、ixpのいずれか。
--description <desc>	—		フリーテキストの説明。
--connector <key>	—	はい integration	コネクタ キー (例: uipath-slack)。
--connector-url <url>	—		コネクタのベース URL (Integration Service ツールのみ)
--object-name <name>	—		Integration Service コネクタのリソース/オブジェクト名 (例: message--connectorと一緒に設定すると、add完全な Integration Service メタデータ パスに切り替わり、Integration Service API が呼び出され、userProfile/debug_overwrites.jsonが書き込まれる可能性があります。
--connection-id <id>	—		このツールにバインドするコネクション ID。--object-nameと共に、接続認識debug_overwrites.json書き込みを有効にします。
--method <method>	POST		ツール操作の HTTP メソッド。
--process-name <name>	—		バインドする Orchestrator プロセス名です。process、agent、apiWorkflow、processOrchestrationのツールの種類に必要です。
--folder-path <path>	—		プロセスがデプロイされる Orchestrator のフォルダー パスです。
--path <path>	.		エージェント プロジェクト ディレクトリへのパスです。

Required flag combinations

• integration ツールには --connectorが必要です。
• --connector が --typeなしで与えられた場合、型はデフォルトで integrationになります。
• 連携ツールで --connector と --object-name の両方を指定する場合、コマンドは Integration Service のメタデータ パスを経由するため、ログイン セッションが必要です。

例

# Process tool bound to an Orchestrator process
uip agent tool add InvoiceLookup \
  --type process \
  --process-name Invoices \
  --folder-path Shared \
  --path ./my-agent

# Integration Service tool, discovered via IS (requires login)
uip agent tool add SlackSender \
  --connector uipath-slack \
  --object-name message \
  --connection-id a1b2c3d4-0000-0000-0000-000000000610

# Integration tool without IS metadata (local only)
uip agent tool add SlackSender --connector uipath-slack

データシェイプ(--output json)

プレーン パス (IS メタデータのないプロセス、エージェント、または連携):

{
  "Code": "AgentToolAdd",
  "Data": {
    "Status": "Tool added and bound to Orchestrator process",
    "Name": "InvoiceLookup",
    "Type": "process",
    "Id": "a1b2c3d4-0000-0000-0000-000000000601",
    "ProcessName": "Invoices",
    "FolderPath": "Shared"
  }
}

ProcessName と FolderPath は、 --process-name が通過したときにのみ存在します。プロセスをバインドしない場合は、代わりに Status "Tool added" されます。

IS メタデータ パス (--connector + --object-name):

{
  "Code": "AgentToolAdd",
  "Data": {
    "Status": "Integration tool added with IS metadata",
    "Name": "SlackSender",
    "Type": "integration",
    "Id": "a1b2c3d4-0000-0000-0000-000000000605",
    "ConnectorKey": "uipath-slack",
    "ObjectName": "message",
    "ConnectionBound": true
  }
}

uip エージェント ツール検出

Integration Service のコネクタによって公開される操作を検出します。IS API を呼び出します。ログインが必要です。

オプション

フラグ	既定 (Default)	Required	目的
--connector <key>	—	○	コネクタ キー。
--connection-id <id>	—		テナント検出用のコネクション ID。

例

uip agent tool discover --connector uipath-slack

データシェイプ(--output json)

{
  "Code": "AgentToolDiscover",
  "Data": [
    {
      "Name": "sendMessage",
      "DisplayName": "Send Message",
      "Type": "integration",
      "ObjectName": "message"
    }
  ]
}

空のコネクタは Data: { "Message": "No tools found for this connector" }を返します。

UIP エージェント ツール接続

すでに追加されている連携ツールにコネクションをバインドします。IS API を呼び出します。ログインが必要です。

引数

• <name> (必須) — 更新するツール名。

オプション

フラグ	既定 (Default)	Required	目的
--connection-id <id>	—	○	バインドするコネクション ID。
--path <path>	.		エージェント プロジェクト ディレクトリへのパスです。

例

uip agent tool connect SlackSender \
  --connection-id a1b2c3d4-0000-0000-0000-000000000610 \
  --path ./my-agent

データシェイプ(--output json)

{
  "Code": "AgentToolConnect",
  "Data": {
    "Status": "Connection bound to tool",
    "Tool": "SlackSender",
    "ConnectionId": "a1b2c3d4-0000-0000-0000-000000000610"
  }
}

UIP エージェント ツール リスト

エージェントに設定されているツールを列挙します。

オプション

フラグ	既定 (Default)	目的
--path <path>	.	エージェント プロジェクト ディレクトリへのパスです。

例

uip agent tool list --path ./my-agent

データシェイプ(--output json)

{
  "Code": "AgentToolList",
  "Data": [
    {
      "Name": "InvoiceLookup",
      "Type": "process",
      "Id": "a1b2c3d4-0000-0000-0000-000000000601",
      "Enabled": true
    }
  ]
}

空のプロジェクトは [ Data: { "Message": "No tools configured" }を返します。

uip エージェント ツールの削除

ツール リソースを削除します。

引数

• <name> (必須) — ツールの名前 または ID。

オプション

フラグ	既定 (Default)	目的
--path <path>	.	エージェント プロジェクト ディレクトリへのパスです。

例

uip agent tool remove InvoiceLookup --path ./my-agent

データシェイプ(--output json)

{
  "Code": "AgentToolRemove",
  "Data": {
    "Status": "Tool removed",
    "Name": "InvoiceLookup"
  }
}

不足しているツールが失敗し、 Tool "<name>" not found および終了コードが 1されます。

関連

• uip agent context — RAG コンテキスト リソース。
• uip agent escalation — HITL/エスカレーション リソース。
• uip agent validate — 一括編集後に再実行。

参照

• 概念: スキル — スキル モデルでツールがどのように表面化するか。
• 認証 — discover と IS-AWARE add パスで使用されるセッション。
• グローバル オプション、 終了コード。