Command Reference ( agent mode )

List of agent mode commands.

agent ( agent_del ) : cmdbox -m agent -c agent_del <Option>

• Deletes agent configuration.

Option	Type	Multi	Required	Default	Choices	Description
--host <host>	str		required	localhost		Specify the service host of the Redis server.
--port <port>	int		required	6379		Specify the service port of the Redis server.
--password <password>	passwd		required	password		Specify the access password of the Redis server (optional). If omitted, password is used.
--svname <svname>	str		required	cmdbox		Specify the service name of the inference server. If omitted, server is used.
--retry_count <retry_count>	int			3		Specifies the number of reconnections to the Redis server.If less than 0 is specified, reconnection is forever.
--retry_interval <retry_interval>	int			5		Specifies the number of seconds before reconnecting to the Redis server.
--timeout <timeout>	int			60		Specify the maximum waiting time until the server responds.
--agent_name <agent_name>	str		required			Specify the name of the agent configuration to delete.

Output Schema

This command implements output_schema() returning Result model.

{
  "success": {
    "performance": [
      {
        "key": "string",
        "value": null
      }
    ],
    "data": "string"
  },
  "warn": {},
  "error": {},
  "output_schema": {},
  "end": false
}

Field	Type	Required	Default	Description
success	Data | null	no	null	成功した場合の結果
success.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
success.data	str | null	no	null	処理結果のデータ
warn	dict[str, any] | list[any] | Data | str | bool | null	no	null	警告がある場合の結果
warn.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
error	dict[str, any] | list[any] | Data | str | bool | null	no	null	エラーがある場合の結果
error.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
output_schema	dict[str, any] | null	no	null	スキーマ情報
end	bool | null	no	null	終了フラグ

agent ( agent_list ) : cmdbox -m agent -c agent_list <Option>

• Lists saved agent configurations.

Option	Type	Multi	Required	Default	Choices	Description
--host <host>	str		required	localhost		Specify the service host of the Redis server.
--port <port>	int		required	6379		Specify the service port of the Redis server.
--password <password>	passwd		required	password		Specify the access password of the Redis server (optional). If omitted, password is used.
--svname <svname>	str		required	cmdbox		Specify the service name of the inference server. If omitted, server is used.
--retry_count <retry_count>	int			3		Specifies the number of reconnections to the Redis server.If less than 0 is specified, reconnection is forever.
--retry_interval <retry_interval>	int			5		Specifies the number of seconds before reconnecting to the Redis server.
--timeout <timeout>	int			60		Specify the maximum waiting time until the server responds.
--kwd <kwd>	str					Specify the name you want to search for. Searches for partial matches.

Output Schema

This command implements output_schema() returning Result model.

{
  "success": {
    "performance": [
      {
        "key": "string",
        "value": null
      }
    ],
    "data": [
      {
        "name": "string",
        "path": "<class 'pathlib.Path'>"
      }
    ]
  },
  "warn": {},
  "error": {},
  "output_schema": {},
  "end": false
}

Field	Type	Required	Default	Description
success	Data	yes	(必須)	成功した場合の結果
success.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
success.data	list[NamePath]	no	(必須)	処理結果のデータ
success.data.name	str	yes	(必須)	名前
success.data.path	Path | str | null	no	null	パス
warn	dict[str, any] | list[any] | Data | str | bool | null	no	null	警告がある場合の結果
warn.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
error	dict[str, any] | list[any] | Data | str | bool | null	no	null	エラーがある場合の結果
error.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
output_schema	dict[str, any] | null	no	null	スキーマ情報
end	bool | null	no	null	終了フラグ

agent ( agent_load ) : cmdbox -m agent -c agent_load <Option>

• Loads agent configuration.

Option	Type	Multi	Required	Default	Choices	Description
--host <host>	str		required	localhost		Specify the service host of the Redis server.
--port <port>	int		required	6379		Specify the service port of the Redis server.
--password <password>	passwd		required	password		Specify the access password of the Redis server (optional). If omitted, password is used.
--svname <svname>	str		required	cmdbox		Specify the service name of the inference server. If omitted, server is used.
--retry_count <retry_count>	int			3		Specifies the number of reconnections to the Redis server.If less than 0 is specified, reconnection is forever.
--retry_interval <retry_interval>	int			5		Specifies the number of seconds before reconnecting to the Redis server.
--timeout <timeout>	int			60		Specify the maximum waiting time until the server responds.
--agent_name <agent_name>	str		required			Specify the name of the agent configuration to load.

Output Schema

This command implements output_schema() returning Result model.

{
  "success": {
    "performance": [
      {
        "key": "string",
        "value": null
      }
    ],
    "agent_name": "string",
    "agent_type": "string",
    "use_planner": false,
    "a2asv_baseurl": "string",
    "a2asv_delegated_auth": false,
    "a2asv_apikey": "string",
    "llm": "string",
    "mcpservers": [
      "string"
    ],
    "subagents": [
      "string"
    ],
    "agent_description": "string",
    "agent_instruction": "string",
    "agent_system_instruction": "string",
    "prompt_param": {}
  },
  "warn": {},
  "error": {},
  "output_schema": {},
  "end": false
}

Field	Type	Required	Default	Description
success	Data	yes	(必須)	成功した場合の結果
success.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
success.agent_name	str	no	null	エージェント名
success.agent_type	str	no	null	エージェントタイプ
success.use_planner	bool | null	no	null	プランナー使用フラグ
success.a2asv_baseurl	str | null	no	null	A2AサーバーのベースURL
success.a2asv_delegated_auth	bool | null	no	null	A2Aサーバーの委任認証フラグ
success.a2asv_apikey	str | null	no	null	A2AサーバーのAPIキー
success.llm	str | null	no	null	LLM名
success.mcpservers	list[str] | null	no	null	MCPサーバーリスト
success.subagents	list[str] | null	no	null	サブエージェントリスト
success.agent_description	str | null	no	null	エージェントの説明
success.agent_instruction	str | null	no	null	エージェントへの指示
success.agent_system_instruction	str | null	no	null	サービス提供側が内部的に設定するシステムプロンプト
success.prompt_param	dict[str, any] | null	no	null	プレースホルダーに対応するパラメータ
warn	dict[str, any] | list[any] | Data | str | bool | null	no	null	警告がある場合の結果
warn.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
error	dict[str, any] | list[any] | Data | str | bool | null	no	null	エラーがある場合の結果
error.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
output_schema	dict[str, any] | null	no	null	スキーマ情報
end	bool | null	no	null	終了フラグ

agent ( agent_save ) : cmdbox -m agent -c agent_save <Option>

• Saves agent configuration.

Option	Type	Multi	Required	Default	Choices	Description
--host <host>	str		required	localhost		Specify the service host of the Redis server.
--port <port>	int		required	6379		Specify the service port of the Redis server.
--password <password>	passwd		required	password		Specify the access password of the Redis server (optional). If omitted, password is used.
--svname <svname>	str		required	cmdbox		Specify the service name of the inference server. If omitted, server is used.
--retry_count <retry_count>	int			3		Specifies the number of reconnections to the Redis server.If less than 0 is specified, reconnection is forever.
--retry_interval <retry_interval>	int			5		Specifies the number of seconds before reconnecting to the Redis server.
--timeout <timeout>	int			60		Specify the maximum waiting time until the server responds.
--agent_name <agent_name>	str		required			Specify the name of the agent configuration to save.
--agent_type <agent_type>	str		required	local	local | remote	Specify the agent type. Specify either local or remote.
--use_planner <use_planner>	bool			False	False | True	Specify whether to use the planning feature of the agent.
--a2asv_baseurl <a2asv_baseurl>	str			http://localhost:8071/a2a/<agent_name>		Specify the base URL for the A2A Server.
--a2asv_delegated_auth <a2asv_delegated_auth>	bool			False	True | False	Authenticate the A2A Server using the API Key of the currently logged-in user.
--a2asv_apikey <a2asv_apikey>	passwd					Specify the API Key when starting the A2A Server. Additionally, if a2asv_delegated_auth is disabled, it will also be used when running the Agent.
--llm <llm>	str		required			Specify the LLM configuration name referenced by the Agent.
--mcpservers <mcpservers>	str	multi				Specify the MCP server name used by the Agent.
--subagents <subagents>	str	multi				Specify the subagent name used by the agent.
--agent_description <agent_description>	text			cmdboxに登録されているコマンド提供		Specify a description of the agent's capabilities. The model uses this to determine whether to delegate control to the agent. A single line description is sufficient and recommended.
--agent_instruction <agent_instruction>	text					Specify instructions for the LLM model used by the agent. These will guide the agent's behavior.
--agent_system_instruction <agent_system_instruction>	text			<system_context><br>役割：あなたは cmdbox Agent であり、cmdbox フレームワークに基づいて構築された高度な自律運用エンジニアです。あなたの主な目的は、cmdboxのカスタムコマンドを動的に調整・実行することで、自由度が高く、あらかじめ定義されていないユーザーのリクエストを解決することです。<br>プラットフォームの機能：cmdboxシステムは、複数の環境（CLI、REST API、Webインターフェース、およびRedisを介したリモートワーカーサーバー）で動作します。社内ツールでは、これらのコマンド機能をModel Context Protocol（MCP）サーバーまたは生の実行可能インターフェースとして公開しています。<br>コグニティブゾーン：あらゆる問題に対して、プロのソフトウェアエンジニアとしての姿勢で取り組む必要があります。ローカルファイルシステムの検索、プロセスツール、データベース、LLMユーティリティを利用できます。パラメータを推測しようとせず、常に分析、検索、検証、実行を行ってください。<br></system_context><br><br><execution_protocol><br>すべての受信リクエストは、以下の順序に従って処理しなければなりません。<br><br>1. 分類とルーティング:<br> - ユーザー入力を分析し、そのクエリが直接的な会話形式の質問（例：挨拶、一般的な概念の説明など）なのか、それともコマンド操作を必要とする機能的なタスクなのかを判断する。<br> - 会話形式の場合は、質の高い専門的な文章で即座に返信する。ツールを起動してはならない。<br> - 機能的なタスクの場合は、動的計画段階に入る。<br><br>2. 探検と発見:<br> - メタデータコンテキストで利用可能なコマンドの一覧を確認し、該当する機能を探してください。<br> - 候補となるツールが見つかったものの、詳細な使用方法がわからない場合は、MCPサーバーからツールの詳細情報を取得してください。ユーザーが指定していないパラメータを勝手に作成しようとしないでください。<br><br>3. 行動する前に考え、確認する:<br> - いかなる機能ツール（特に破壊的またはシステムを変更するコマンド）を呼び出す前に、現在の状態を分析するために、必ず <thinking> XML ブロックを出力する必要があります。<br> - 内なる独白の中で、明確な計画を立て、パラメータの型（整数か文字列か）を確認し、終了条件や成功条件を確立しなければなりません。<br><br>4. ステップバイステップのリアクトループ:<br> - コマンドは1つずつ実行してください。複数の書き込みコマンドを無闇に連鎖させてはいけません。<br> - 各 cmdbox コマンドの実行によって返される stdout/stderr または JSON ペイロードを必ず確認してください。<br> - コマンドの実行結果は JSON 文字列で出力するようにしてください。この時 JSON 文字列は「`json」と「`」で囲んだ文字列にしてください。<br> - もし出力内容に Markdown の構文が含まれている場合は、出力する前に JSON 文字列 に変換してください。この時、JSON 文字列は「`json」と「`」で囲んだ文字列にしてください。<br> - コマンドが失敗した場合、自己修正ロジックを使用してください。思考ブロック内でエラーメッセージを分析し、オプションを変更して再試行してください。あるステップが 3 回連続で失敗した場合は、一旦停止し、オペレーターに指示を求めてください。<br><br>5. 応答の合成:<br> - すべての出力を、ユーザーの入力言語（例：クエリが日本語の場合は日本語）に翻訳する。<br> - ユーザーが求めている結果にコマンドのJSON文字列の実行結果が含まれる場合、前項の「`json」で「`」で囲んだ文字列は変更しないでください。<br> - 最終結果は事実に基づく要約として提示し、曖昧なプレースホルダーや架空のログは避ける。<br></execution_protocol><br><br><thinking_scratchpad_protocol><br>`<thinking>` 出力を生成する場合は、以下の点に留意する必要があります:<br>- 現状チェックリスト：これまでに何が達成されたか？<br>- 検討中の制約事項：どのようなセキュリティパラメータやローカライズされたルールが指定されているか？<br>- コマンド生成チェック：生成された CLI コマンドの構造は、cmdbox の構文ガイドラインに準拠していますか？<br>- リスク軽減策：この操作は元に戻せますか？元に戻せない場合、ユーザーに確認しましたか、あるいはドライランを実施しましたか？<br></thinking_scratchpad_protocol><br><br><formatting_and_style><br>- 極めて専門的で、客観的かつ中立的な口調を保つこと。感情的な表現、謝罪、無駄な装飾は避けること。<br>- 構成の明瞭さを最優先すること。データの直接比較やパラメータのスキーマについては、Markdownの表を活用すること。<br>- 最終的な回答は、読みやすい文章で記述すること。厳密に順序立てられた技術的な手順を説明する場合を除き、箇条書きが密集した段落は避けること。<br>- 語彙は、標準的なシステム管理および情報技術の用語に合わせる。<br></formatting_and_style><br>		Specify a system prompt set internally by the service provider without exposing it to end users. Like agent_instruction, it is passed to the Agent, but this one is private.
--prompt_param <prompt_param>	dict	multi				Specify parameters corresponding to placeholders embedded in agent_instruction or agent_system_instruction. Example: {"key": "value"}

Output Schema

This command implements output_schema() returning Result model.

{
  "success": {
    "performance": [
      {
        "key": "string",
        "value": null
      }
    ],
    "data": "string"
  },
  "warn": {},
  "error": {},
  "output_schema": {},
  "end": false
}

Field	Type	Required	Default	Description
success	Data | null	no	null	成功した場合の結果
success.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
success.data	str | null	no	null	処理結果のデータ
warn	dict[str, any] | list[any] | Data | str | bool | null	no	null	警告がある場合の結果
warn.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
error	dict[str, any] | list[any] | Data | str | bool | null	no	null	エラーがある場合の結果
error.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
output_schema	dict[str, any] | null	no	null	スキーマ情報
end	bool | null	no	null	終了フラグ

agent ( chat ) : cmdbox -m agent -c chat <Option>

• Chat with the agent.

Option	Type	Multi	Required	Default	Choices	Description
--host <host>	str		required	localhost		Specify the service host of the Redis server.
--port <port>	int		required	6379		Specify the service port of the Redis server.
--password <password>	passwd		required	password		Specify the access password of the Redis server (optional). If omitted, password is used.
--svname <svname>	str		required	cmdbox		Specify the service name of the inference server.
--retry_count <retry_count>	int			3		Specifies the number of reconnections to the Redis server.
--retry_interval <retry_interval>	int			5		Specifies the number of seconds before reconnecting to the Redis server.
--timeout <timeout>	int			600		Specify the maximum waiting time until the server responds.
--runner_name <runner_name>	str		required			Specify the name of the Runner configuration.
--user_name <user_name>	str		required			Specify a user name.
--session_id <session_id>	str					Specify the session ID to send to the Runner.
--a2asv_apikey <a2asv_apikey>	passwd					Specify the API Key of the A2A Server.
--mcpserver_apikey <mcpserver_apikey>	passwd					Specify the API Key of the remote MCP server.
--message <message>	text		required			Specify the message to send to the Runner.
--call_tts <call_tts>	bool			False	True | False	Specify whether to execute the TTS (Text-to-Speech) feature.

Output Schema

This command implements output_schema() returning Result model.

{
  "success": {
    "performance": [
      {
        "key": "string",
        "value": null
      }
    ],
    "ids": {
      "agent_session_id": "string",
      "event_id": "string",
      "invocation_id": "string"
    },
    "flags": {
      "final_response": false,
      "function_call": false,
      "function_response": false
    },
    "message": "string",
    "wav_b64": "string",
    "ressize": 0
  },
  "warn": {},
  "error": {},
  "output_schema": {},
  "end": false
}

Field	Type	Required	Default	Description
success	Data | null	no	null	成功した場合の結果
success.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
success.ids	Ids | null	no	null	セッション・イベントID情報
success.ids.agent_session_id	str	no	null	エージェントセッションID
success.ids.event_id	str	no	null	イベントID
success.ids.invocation_id	str	no	null	呼び出しID
success.flags	Flags | null	no	null	フラグ情報
success.flags.final_response	bool	no	False	最終レスポンスフラグ
success.flags.function_call	bool	no	False	関数呼び出しフラグ
success.flags.function_response	bool	no	False	関数レスポンスフラグ
success.message	str | null	no	null	メッセージ
success.wav_b64	str | null	no	null	Base64エンコードされたWAVデータ
success.ressize	int | null	no	null	Agentが返したレスポンスのサイズ
warn	dict[str, any] | list[any] | Data | str | bool | null	no	null	警告がある場合の結果
warn.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
error	dict[str, any] | list[any] | Data | str | bool | null	no	null	エラーがある場合の結果
error.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
output_schema	dict[str, any] | null	no	null	スキーマ情報
end	bool | null	no	null	終了フラグ

agent ( mcp_client ) : cmdbox -m agent -c mcp_client <Option>

• Starts an MCP client that makes requests to a remote MCP server.

Option	Type	Multi	Required	Default	Choices	Description
--mcpserver_name <mcpserver_name>	str		required	mcpserver		Specify the name of the MCP server. If omitted, it will be mcpserver.
--mcpserver_url <mcpserver_url>	str		required	http://localhost:8091/mcp		Specifies the URL of the remote MCP server. If omitted, it will be http://localhost:8091/mcp.
--mcpserver_apikey <mcpserver_apikey>	passwd					Specify the API Key of the remote MCP server.
--mcpserver_transport <mcpserver_transport>	str		required	streamable-http	streamable-http | sse | http	Specifies the transport of the remote MCP server. If omitted, it is streamable-http.
--operation <operation>	str		required	list_tools	list_tools | call_tool | list_resources | read_resource | list_prompts | get_prompt	Specifies the operations to request from the remote MCP server. If omitted, list_tools is used.
--tool_name <tool_name>	str					Specify the name of the tool to run on the remote MCP server.
--tool_args <tool_args>	dict	multi				Specify arguments for the tool to run on the remote MCP server.
--mcp_timeout <mcp_timeout>	int			60		Specifies the maximum time to wait for a response from the remote MCP server.
--resource_url <resource_url>	str					Specify the URL of the resource to retrieve from the remote MCP server.
--prompt_name <prompt_name>	str					Specifies the name of the prompt to be retrieved from the remote MCP server.
--prompt_args <prompt_args>	dict	multi				Specifies prompt arguments to be retrieved from the remote MCP server.

Output Schema

This command implements output_schema() returning Result model.

{
  "success": null,
  "warn": {},
  "error": {},
  "output_schema": {},
  "end": false
}

Field	Type	Required	Default	Description
success	any | null	no	null	成功した場合の結果
warn	dict[str, any] | list[any] | Data | str | bool | null	no	null	警告がある場合の結果
warn.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
error	dict[str, any] | list[any] | Data | str | bool | null	no	null	エラーがある場合の結果
error.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
output_schema	dict[str, any] | null	no	null	スキーマ情報
end	bool | null	no	null	終了フラグ

agent ( mcp_proxy ) : cmdbox -m agent -c mcp_proxy <Option>

• Starts a Proxy server that accepts standard input and makes requests to a remote MCP server.

Option	Type	Multi	Required	Default	Choices	Description
--mcpserver_name <mcpserver_name>	str		required	mcpserver		Specify the name of the MCP server. If omitted, it will be mcpserver.
--mcpserver_url <mcpserver_url>	str		required	http://localhost:8091/mcp		Specifies the URL of the remote MCP server. If omitted, it will be http://localhost:8091/mcp.
--mcpserver_apikey <mcpserver_apikey>	passwd					Specify the API Key of the remote MCP server.
--mcpserver_transport <mcpserver_transport>	str		required	streamable-http	streamable-http | sse | http	Specifies the transport of the remote MCP server. If omitted, it is streamable-http.

Output Schema

This command implements output_schema() returning Result model.

{
  "success": {
    "performance": [
      {
        "key": "string",
        "value": null
      }
    ],
    "data": "string"
  },
  "warn": {},
  "error": {},
  "output_schema": {},
  "end": false
}

Field	Type	Required	Default	Description
success	Data | null	no	null	成功した場合の結果
success.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
success.data	str | null	no	null	処理結果のデータ
warn	dict[str, any] | list[any] | Data | str | bool | null	no	null	警告がある場合の結果
warn.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
error	dict[str, any] | list[any] | Data | str | bool | null	no	null	エラーがある場合の結果
error.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
output_schema	dict[str, any] | null	no	null	スキーマ情報
end	bool | null	no	null	終了フラグ

agent ( mcpsv_del ) : cmdbox -m agent -c mcpsv_del <Option>

• Deletes MCP server configuration.

Option	Type	Multi	Required	Default	Choices	Description
--host <host>	str		required	localhost		Specify the service host of the Redis server.
--port <port>	int		required	6379		Specify the service port of the Redis server.
--password <password>	passwd		required	password		Specify the access password of the Redis server (optional). If omitted, password is used.
--svname <svname>	str		required	cmdbox		Specify the service name of the inference server. If omitted, server is used.
--retry_count <retry_count>	int			3		Specifies the number of reconnections to the Redis server.If less than 0 is specified, reconnection is forever.
--retry_interval <retry_interval>	int			5		Specifies the number of seconds before reconnecting to the Redis server.
--timeout <timeout>	int			60		Specify the maximum waiting time until the server responds.
--mcpserver_name <mcpserver_name>	str		required			Specify the name of the MCP server configuration to delete.

Output Schema

This command implements output_schema() returning Result model.

{
  "success": {
    "performance": [
      {
        "key": "string",
        "value": null
      }
    ],
    "data": "string"
  },
  "warn": {},
  "error": {},
  "output_schema": {},
  "end": false
}

Field	Type	Required	Default	Description
success	Data | null	no	null	成功した場合の結果
success.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
success.data	str | null	no	null	処理結果のデータ
warn	dict[str, any] | list[any] | Data | str | bool | null	no	null	警告がある場合の結果
warn.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
error	dict[str, any] | list[any] | Data | str | bool | null	no	null	エラーがある場合の結果
error.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
output_schema	dict[str, any] | null	no	null	スキーマ情報
end	bool | null	no	null	終了フラグ

agent ( mcpsv_list ) : cmdbox -m agent -c mcpsv_list <Option>

• Lists saved MCP server configurations.

Option	Type	Multi	Required	Default	Choices	Description
--host <host>	str		required	localhost		Specify the service host of the Redis server.
--port <port>	int		required	6379		Specify the service port of the Redis server.
--password <password>	passwd		required	password		Specify the access password of the Redis server (optional). If omitted, password is used.
--svname <svname>	str		required	cmdbox		Specify the service name of the inference server. If omitted, server is used.
--retry_count <retry_count>	int			3		Specifies the number of reconnections to the Redis server.If less than 0 is specified, reconnection is forever.
--retry_interval <retry_interval>	int			5		Specifies the number of seconds before reconnecting to the Redis server.
--timeout <timeout>	int			60		Specify the maximum waiting time until the server responds.
--kwd <kwd>	str					Specify the name you want to search for. Searches for partial matches.

Output Schema

This command implements output_schema() returning Result model.

{
  "success": {
    "performance": [
      {
        "key": "string",
        "value": null
      }
    ],
    "data": [
      {
        "name": "string",
        "path": "<class 'pathlib.Path'>"
      }
    ]
  },
  "warn": {},
  "error": {},
  "output_schema": {},
  "end": false
}

Field	Type	Required	Default	Description
success	Data | null	no	null	成功した場合の結果
success.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
success.data	list[NamePath]	no	(必須)	処理結果のデータ
success.data.name	str	yes	(必須)	名前
success.data.path	Path | str | null	no	null	パス
warn	dict[str, any] | list[any] | Data | str | bool | null	no	null	警告がある場合の結果
warn.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
error	dict[str, any] | list[any] | Data | str | bool | null	no	null	エラーがある場合の結果
error.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
output_schema	dict[str, any] | null	no	null	スキーマ情報
end	bool | null	no	null	終了フラグ

agent ( mcpsv_load ) : cmdbox -m agent -c mcpsv_load <Option>

• Loads MCP server configuration.

Option	Type	Multi	Required	Default	Choices	Description
--host <host>	str		required	localhost		Specify the service host of the Redis server.
--port <port>	int		required	6379		Specify the service port of the Redis server.
--password <password>	passwd		required	password		Specify the access password of the Redis server (optional). If omitted, password is used.
--svname <svname>	str		required	cmdbox		Specify the service name of the inference server. If omitted, server is used.
--retry_count <retry_count>	int			3		Specifies the number of reconnections to the Redis server.If less than 0 is specified, reconnection is forever.
--retry_interval <retry_interval>	int			5		Specifies the number of seconds before reconnecting to the Redis server.
--timeout <timeout>	int			60		Specify the maximum waiting time until the server responds.
--mcpserver_name <mcpserver_name>	str		required			Specify the name of the MCP server configuration to load.

Output Schema

This command implements output_schema() returning Result model.

{
  "success": {
    "performance": [
      {
        "key": "string",
        "value": null
      }
    ],
    "mcpserver_name": "string",
    "mcpserver_url": "string",
    "mcpserver_apikey": "string",
    "mcpserver_delegated_auth": false,
    "mcpserver_transport": "string",
    "mcpserver_mcp_tools": [
      "string"
    ]
  },
  "warn": {},
  "error": {},
  "output_schema": {},
  "end": false
}

Field	Type	Required	Default	Description
success	Data | null	no	null	成功した場合の結果
success.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
success.mcpserver_name	str | null	no	null	MCPサーバー名
success.mcpserver_url	str | null	no	null	MCPサーバーURL
success.mcpserver_apikey	str | null	no	null	MCPサーバーAPIキー
success.mcpserver_delegated_auth	bool | null	no	null	MCPサーバー委任認証フラグ
success.mcpserver_transport	str | null	no	null	MCPサーバートランスポート
success.mcpserver_mcp_tools	list[str] | null	no	null	MCPツールリスト
warn	dict[str, any] | list[any] | Data | str | bool | null	no	null	警告がある場合の結果
warn.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
error	dict[str, any] | list[any] | Data | str | bool | null	no	null	エラーがある場合の結果
error.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
output_schema	dict[str, any] | null	no	null	スキーマ情報
end	bool | null	no	null	終了フラグ

agent ( mcpsv_save ) : cmdbox -m agent -c mcpsv_save <Option>

• Saves MCP server configuration.

Option	Type	Multi	Required	Default	Choices	Description
--host <host>	str		required	localhost		Specify the service host of the Redis server.
--port <port>	int		required	6379		Specify the service port of the Redis server.
--password <password>	passwd		required	password		Specify the access password of the Redis server (optional). If omitted, password is used.
--svname <svname>	str		required	cmdbox		Specify the service name of the inference server. If omitted, server is used.
--retry_count <retry_count>	int			3		Specifies the number of reconnections to the Redis server.If less than 0 is specified, reconnection is forever.
--retry_interval <retry_interval>	int			5		Specifies the number of seconds before reconnecting to the Redis server.
--timeout <timeout>	int			60		Specify the maximum waiting time until the server responds.
--mcpserver_name <mcpserver_name>	str		required	mcpserver		Specify the name of the MCP server. If omitted, it will be mcpserver.
--mcpserver_url <mcpserver_url>	str		required	http://localhost:8091/mcp		Specifies the URL of the remote MCP server. If omitted, it will be http://localhost:8091/mcp.
--mcpserver_delegated_auth <mcpserver_delegated_auth>	bool			False	True | False	Authenticate with the remote MCP server using the API key of the currently logged-in user.
--mcpserver_apikey <mcpserver_apikey>	passwd					Specifies the API Key for the remote MCP server when starting the A2A Server. If mcpserver_delegated_auth is disabled, it is also used when running MCP.
--mcpserver_transport <mcpserver_transport>	str		required	streamable-http	streamable-http | sse	Specifies the transport of the remote MCP server. If omitted, it is streamable-http.
--mcp_tools <mcp_tools>	mlist					Specify the tools provided by the remote server.

Output Schema

This command implements output_schema() returning Result model.

{
  "success": {
    "performance": [
      {
        "key": "string",
        "value": null
      }
    ],
    "data": "string"
  },
  "warn": {},
  "error": {},
  "output_schema": {},
  "end": false
}

Field	Type	Required	Default	Description
success	Data | null	no	null	成功した場合の結果
success.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
success.data	str | null	no	null	処理結果のデータ
warn	dict[str, any] | list[any] | Data | str | bool | null	no	null	警告がある場合の結果
warn.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
error	dict[str, any] | list[any] | Data | str | bool | null	no	null	エラーがある場合の結果
error.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
output_schema	dict[str, any] | null	no	null	スキーマ情報
end	bool | null	no	null	終了フラグ

agent ( runner_del ) : cmdbox -m agent -c runner_del <Option>

• Deletes runner configuration.

Option	Type	Multi	Required	Default	Choices	Description
--host <host>	str		required	localhost		Specify the service host of the Redis server.
--port <port>	int		required	6379		Specify the service port of the Redis server.
--password <password>	passwd		required	password		Specify the access password of the Redis server (optional). If omitted, password is used.
--svname <svname>	str		required	cmdbox		Specify the service name of the inference server. If omitted, server is used.
--retry_count <retry_count>	int			3		Specifies the number of reconnections to the Redis server.If less than 0 is specified, reconnection is forever.
--retry_interval <retry_interval>	int			5		Specifies the number of seconds before reconnecting to the Redis server.
--timeout <timeout>	int			60		Specify the maximum waiting time until the server responds.
--runner_name <runner_name>	str		required			Specify the name of the runner configuration to delete.

Output Schema

This command implements output_schema() returning Result model.

{
  "success": {
    "performance": [
      {
        "key": "string",
        "value": null
      }
    ],
    "data": "string"
  },
  "warn": {},
  "error": {},
  "output_schema": {},
  "end": false
}

Field	Type	Required	Default	Description
success	Data | null	no	null	成功した場合の結果
success.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
success.data	str | null	no	null	処理結果のデータ
warn	dict[str, any] | list[any] | Data | str | bool | null	no	null	警告がある場合の結果
warn.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
error	dict[str, any] | list[any] | Data | str | bool | null	no	null	エラーがある場合の結果
error.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
output_schema	dict[str, any] | null	no	null	スキーマ情報
end	bool | null	no	null	終了フラグ

agent ( runner_list ) : cmdbox -m agent -c runner_list <Option>

• Lists saved runner configurations.

Option	Type	Multi	Required	Default	Choices	Description
--host <host>	str		required	localhost		Specify the service host of the Redis server.
--port <port>	int		required	6379		Specify the service port of the Redis server.
--password <password>	passwd		required	password		Specify the access password of the Redis server (optional). If omitted, password is used.
--svname <svname>	str		required	cmdbox		Specify the service name of the inference server. If omitted, server is used.
--retry_count <retry_count>	int			3		Specifies the number of reconnections to the Redis server.If less than 0 is specified, reconnection is forever.
--retry_interval <retry_interval>	int			5		Specifies the number of seconds before reconnecting to the Redis server.
--timeout <timeout>	int			60		Specify the maximum waiting time until the server responds.
--kwd <kwd>	str					Specify the name you want to search for. Searches for partial matches.

Output Schema

This command implements output_schema() returning Result model.

{
  "success": {
    "performance": [
      {
        "key": "string",
        "value": null
      }
    ],
    "data": [
      {
        "name": "string",
        "path": "<class 'pathlib.Path'>"
      }
    ]
  },
  "warn": {},
  "error": {},
  "output_schema": {},
  "end": false
}

Field	Type	Required	Default	Description
success	Data | null	no	null	成功した場合の結果
success.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
success.data	list[NamePath]	no	(必須)	処理結果のデータ
success.data.name	str	yes	(必須)	名前
success.data.path	Path | str | null	no	null	パス
warn	dict[str, any] | list[any] | Data | str | bool | null	no	null	警告がある場合の結果
warn.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
error	dict[str, any] | list[any] | Data | str | bool | null	no	null	エラーがある場合の結果
error.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
output_schema	dict[str, any] | null	no	null	スキーマ情報
end	bool | null	no	null	終了フラグ

agent ( runner_load ) : cmdbox -m agent -c runner_load <Option>

• Loads runner configuration.

Option	Type	Multi	Required	Default	Choices	Description
--host <host>	str		required	localhost		Specify the service host of the Redis server.
--port <port>	int		required	6379		Specify the service port of the Redis server.
--password <password>	passwd		required	password		Specify the access password of the Redis server (optional). If omitted, password is used.
--svname <svname>	str		required	cmdbox		Specify the service name of the inference server. If omitted, server is used.
--retry_count <retry_count>	int			3		Specifies the number of reconnections to the Redis server.If less than 0 is specified, reconnection is forever.
--retry_interval <retry_interval>	int			5		Specifies the number of seconds before reconnecting to the Redis server.
--timeout <timeout>	int			60		Specify the maximum waiting time until the server responds.
--runner_name <runner_name>	str		required			Specify the name of the runner configuration to load.

Output Schema

This command implements output_schema() returning Result model.

{
  "success": {
    "performance": [
      {
        "key": "string",
        "value": null
      }
    ],
    "runner_name": "string",
    "agent": "string",
    "session_datasource": "string",
    "tts_engine": "string",
    "rag": [
      "string"
    ],
    "voicevox_model": "string"
  },
  "warn": {},
  "error": {},
  "output_schema": {},
  "end": false
}

Field	Type	Required	Default	Description
success	Data | null	no	null	成功した場合の結果
success.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
success.runner_name	str | null	no	null	ランナー名
success.agent	str | null	no	null	エージェント名
success.session_datasource	str | null	no	null	セッションデータソース
success.tts_engine	str | null	no	null	TTSエンジン名
success.rag	list[str] | null	no	null	RAG設定リスト
success.voicevox_model	str | null	no	null	VOICEVOXモデル
warn	dict[str, any] | list[any] | Data | str | bool | null	no	null	警告がある場合の結果
warn.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
error	dict[str, any] | list[any] | Data | str | bool | null	no	null	エラーがある場合の結果
error.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
output_schema	dict[str, any] | null	no	null	スキーマ情報
end	bool | null	no	null	終了フラグ

agent ( runner_save ) : cmdbox -m agent -c runner_save <Option>

• Saves runner configuration.

Option	Type	Multi	Required	Default	Choices	Description
--host <host>	str		required	localhost		Specify the service host of the Redis server.
--port <port>	int		required	6379		Specify the service port of the Redis server.
--password <password>	passwd		required	password		Specify the access password of the Redis server (optional). If omitted, password is used.
--svname <svname>	str		required	cmdbox		Specify the service name of the inference server. If omitted, server is used.
--retry_count <retry_count>	int			3		Specifies the number of reconnections to the Redis server.If less than 0 is specified, reconnection is forever.
--retry_interval <retry_interval>	int			5		Specifies the number of seconds before reconnecting to the Redis server.
--timeout <timeout>	int			60		Specify the maximum waiting time until the server responds.
--runner_name <runner_name>	str		required			Specify the name of the runner configuration to save.
--agent <agent>	str		required			Specify the Agent configuration name referenced by the Runner.
--session_datasource <session_datasource>	str		required			Specify the data source where sessions will be saved.
--tts_engine <tts_engine>	str		required	voicevox	voicevox	Specify the TTS engine to use.
--rag <rag>	str	multi				Specify the RAG configuration name referenced by the Runner.
--voicevox_model <voicevox_model>	str				No.7アナウンス | No.7ノーマル | No.7読み聞かせ | Voidollノーマル | WhiteCULかなしい | WhiteCULたのしい | WhiteCULびえーん | WhiteCULノーマル | †聖騎士 紅桜†ノーマル | あいえるたんノーマル | ずんだもんあまあま | ずんだもんささやき | ずんだもんなみだめ | ずんだもんセクシー | ずんだもんツンツン | ずんだもんノーマル | ずんだもんヒソヒソ | ずんだもんヘロヘロ | ぞん子ノーマル | ぞん子低血圧 | ぞん子実況風 | ぞん子覚醒 | ちび式じいノーマル | もち子さんのんびり | もち子さんセクシー／あん子 | もち子さんノーマル | もち子さん喜び | もち子さん怒り | もち子さん泣き | ナースロボ＿タイプＴノーマル | ナースロボ＿タイプＴ内緒話 | ナースロボ＿タイプＴ恐怖 | ナースロボ＿タイプＴ楽々 | ユーレイちゃんささやき | ユーレイちゃんツクモちゃん | ユーレイちゃんノーマル | ユーレイちゃん哀しみ | ユーレイちゃん甘々 | 中国うさぎおどろき | 中国うさぎこわがり | 中国うさぎへろへろ | 中国うさぎノーマル | 中部つるぎおどおど | 中部つるぎノーマル | 中部つるぎヒソヒソ | 中部つるぎ怒り | 中部つるぎ絶望と敗北 | 九州そらあまあま | 九州そらささやき | 九州そらセクシー | 九州そらツンツン | 九州そらノーマル | 冥鳴ひまりノーマル | 剣崎雌雄ノーマル | 四国めたんあまあま | 四国めたんささやき | 四国めたんセクシー | 四国めたんツンツン | 四国めたんノーマル | 四国めたんヒソヒソ | 小夜/SAYOノーマル | 後鬼ぬいぐるみver. | 後鬼人間ver. | 後鬼人間（怒り）ver. | 後鬼鬼ver. | 春日部つむぎノーマル | 春歌ナナノーマル | 東北きりたんノーマル | 東北ずん子ノーマル | 東北イタコノーマル | 栗田まろんノーマル | 櫻歌ミコノーマル | 櫻歌ミコロリ | 櫻歌ミコ第二形態 | 波音リツクイーン | 波音リツノーマル | 満別花丸ささやき | 満別花丸ぶりっ子 | 満別花丸ノーマル | 満別花丸ボーイ | 満別花丸元気 | 猫使アルうきうき | 猫使アルおちつき | 猫使アルつよつよ | 猫使アルへろへろ | 猫使アルノーマル | 猫使ビィおちつき | 猫使ビィつよつよ | 猫使ビィノーマル | 猫使ビィ人見知り | 玄野武宏ツンギレ | 玄野武宏ノーマル | 玄野武宏喜び | 玄野武宏悲しみ | 琴詠ニアノーマル | 白上虎太郎おこ | 白上虎太郎びえーん | 白上虎太郎びくびく | 白上虎太郎ふつう | 白上虎太郎わーい | 雀松朱司ノーマル | 離途シリアス | 離途ノーマル | 雨晴はうノーマル | 青山龍星かなしみ | 青山龍星しっとり | 青山龍星ノーマル | 青山龍星不機嫌 | 青山龍星喜び | 青山龍星囁き | 青山龍星熱血 | 麒ヶ島宗麟ノーマル | 黒沢冴白ノーマル	Specify the model of the TTS engine to use.

Output Schema

This command implements output_schema() returning Result model.

{
  "success": {
    "performance": [
      {
        "key": "string",
        "value": null
      }
    ],
    "data": "string"
  },
  "warn": {},
  "error": {},
  "output_schema": {},
  "end": false
}

Field	Type	Required	Default	Description
success	Data | null	no	null	成功した場合の結果
success.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
success.data	str | null	no	null	処理結果のデータ
warn	dict[str, any] | list[any] | Data | str | bool | null	no	null	警告がある場合の結果
warn.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
error	dict[str, any] | list[any] | Data | str | bool | null	no	null	エラーがある場合の結果
error.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
output_schema	dict[str, any] | null	no	null	スキーマ情報
end	bool | null	no	null	終了フラグ

agent ( session_del ) : cmdbox -m agent -c session_del <Option>

• Delete sessions for the agent.

Option	Type	Multi	Required	Default	Choices	Description
--host <host>	str		required	localhost		Specify the service host of the Redis server.
--port <port>	int		required	6379		Specify the service port of the Redis server.
--password <password>	passwd		required	password		Specify the access password of the Redis server (optional). If omitted, password is used.
--svname <svname>	str		required	cmdbox		Specify the service name of the inference server.
--retry_count <retry_count>	int			3		Specifies the number of reconnections to the Redis server.
--retry_interval <retry_interval>	int			5		Specifies the number of seconds before reconnecting to the Redis server.
--timeout <timeout>	int			120		Specify the maximum waiting time until the server responds.
--runner_name <runner_name>	str		required			Specify the name of the Runner configuration.
--user_name <user_name>	str		required			Specify a user name.
--session_id <session_id>	str		required			Specify the session ID to send to the Runner.

Output Schema

This command implements output_schema() returning Result model.

{
  "success": {
    "performance": [
      {
        "key": "string",
        "value": null
      }
    ],
    "data": [
      "string"
    ]
  },
  "warn": {},
  "error": {},
  "output_schema": {},
  "end": false
}

Field	Type	Required	Default	Description
success	Data | null	no	null	成功した場合の結果
success.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
success.data	list[str] | null	no	null	処理結果のデータ
warn	dict[str, any] | list[any] | Data | str | bool | null	no	null	警告がある場合の結果
warn.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
error	dict[str, any] | list[any] | Data | str | bool | null	no	null	エラーがある場合の結果
error.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
output_schema	dict[str, any] | null	no	null	スキーマ情報
end	bool | null	no	null	終了フラグ

agent ( session_list ) : cmdbox -m agent -c session_list <Option>

• List sessions for the agent.

Option	Type	Multi	Required	Default	Choices	Description
--host <host>	str		required	localhost		Specify the service host of the Redis server.
--port <port>	int		required	6379		Specify the service port of the Redis server.
--password <password>	passwd		required	password		Specify the access password of the Redis server (optional). If omitted, password is used.
--svname <svname>	str		required	cmdbox		Specify the service name of the inference server.
--retry_count <retry_count>	int			3		Specifies the number of reconnections to the Redis server.
--retry_interval <retry_interval>	int			5		Specifies the number of seconds before reconnecting to the Redis server.
--timeout <timeout>	int			120		Specify the maximum waiting time until the server responds.
--runner_name <runner_name>	str		required			Specify the name of the Runner configuration.
--user_name <user_name>	str		required			Specify a user name.
--session_id <session_id>	str					Specify the session ID to send to the Runner.

Output Schema

This command implements output_schema() returning Result model.

{
  "success": {
    "performance": [
      {
        "key": "string",
        "value": null
      }
    ],
    "data": [
      {
        "runner_name": "string",
        "session_id": "string",
        "user_name": "string",
        "last_update_time": null,
        "events": [
          {
            "author": "string",
            "text": "string",
            "final_response": false,
            "function_call": false,
            "function_response": false
          }
        ]
      }
    ]
  },
  "warn": {},
  "error": {},
  "output_schema": {},
  "end": false
}

Field	Type	Required	Default	Description
success	Data | null	no	null	成功した場合の結果
success.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
success.data	list[SessionRecord] | null	no	null	処理結果のデータ
warn	dict[str, any] | list[any] | Data | str | bool | null	no	null	警告がある場合の結果
warn.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
error	dict[str, any] | list[any] | Data | str | bool | null	no	null	エラーがある場合の結果
error.performance	list[KeyVal] | null	no	null	パフォーマンス情報のリスト
output_schema	dict[str, any] | null	no	null	スキーマ情報
end	bool | null	no	null	終了フラグ