From bd668931c7845d109ab84f65ec871410de6dab24 Mon Sep 17 00:00:00 2001 From: ysyneu Date: Mon, 29 Jun 2026 17:09:46 +0800 Subject: [PATCH] docs: rename A2A instructions field --- api-reference/openapi.en.json | 26 ++++++++++++++------------ api-reference/openapi.zh.json | 26 ++++++++++++++------------ api-reference/safari.openapi.en.json | 26 ++++++++++++++------------ api-reference/safari.openapi.zh.json | 26 ++++++++++++++------------ 4 files changed, 56 insertions(+), 48 deletions(-) diff --git a/api-reference/openapi.en.json b/api-reference/openapi.en.json index 8dbead4..a28f35f 100644 --- a/api-reference/openapi.en.json +++ b/api-reference/openapi.en.json @@ -21763,6 +21763,7 @@ }, "example": { "agent_name": "deploy-bot", + "instructions": "Use when deployment pipelines need inspection or rollback advice.", "card_url": "https://agents.example.com/deploy-bot/card", "auth_type": "bearer", "streaming": true, @@ -21823,7 +21824,6 @@ "team_id": 0, "can_edit": true, "agent_name": "deploy-bot", - "description": "Remote agent that inspects deployment pipelines.", "card_url": "https://agents.example.com/deploy-bot/card", "auth_type": "bearer", "streaming": true, @@ -21838,7 +21838,8 @@ "auth_mode": "shared", "created_by": 80011, "created_at": 1716960000000, - "updated_at": 1717046400000 + "updated_at": 1717046400000, + "instructions": "Remote agent that inspects deployment pipelines." } ], "total": 1 @@ -21925,7 +21926,6 @@ "team_id": 0, "can_edit": true, "agent_name": "deploy-bot", - "description": "Remote agent that inspects deployment pipelines.", "card_url": "https://agents.example.com/deploy-bot/card", "auth_type": "bearer", "streaming": true, @@ -21940,7 +21940,8 @@ "auth_mode": "shared", "created_by": 80011, "created_at": 1716960000000, - "updated_at": 1717046400000 + "updated_at": 1717046400000, + "instructions": "Remote agent that inspects deployment pipelines." } } } @@ -22047,7 +22048,7 @@ }, "example": { "agent_id": "a2a_6mWqZ2pK9nLcR3tY8uVb4D", - "description": "Inspects deployment pipelines and proposes rollbacks." + "instructions": "Inspect deployment pipelines and propose rollback steps." } } } @@ -42257,9 +42258,9 @@ "type": "string", "description": "Agent display name." }, - "description": { + "instructions": { "type": "string", - "description": "Agent description." + "description": "Invocation instructions included in AI SRE's system prompt to decide when to call this A2A agent." }, "card_url": { "type": "string", @@ -42346,7 +42347,7 @@ "team_id", "can_edit", "agent_name", - "description", + "instructions", "card_url", "auth_type", "streaming", @@ -42374,12 +42375,12 @@ "description": "New display name. Omit to leave unchanged.", "maxLength": 128 }, - "description": { + "instructions": { "type": [ "string", "null" ], - "description": "New description. Omit to leave unchanged.", + "description": "New invocation instructions. Omit to leave unchanged; when supplied, must be nonblank.", "maxLength": 2000 }, "card_url": { @@ -42453,9 +42454,9 @@ "description": "Agent display name.", "maxLength": 128 }, - "description": { + "instructions": { "type": "string", - "description": "Agent description.", + "description": "Invocation instructions included in AI SRE's system prompt to decide when to call this A2A agent. Must be nonblank.", "maxLength": 2000 }, "card_url": { @@ -42497,6 +42498,7 @@ }, "required": [ "agent_name", + "instructions", "card_url" ] }, diff --git a/api-reference/openapi.zh.json b/api-reference/openapi.zh.json index a033db6..eec7d36 100644 --- a/api-reference/openapi.zh.json +++ b/api-reference/openapi.zh.json @@ -21755,6 +21755,7 @@ }, "example": { "agent_name": "deploy-bot", + "instructions": "当需要检查部署流水线或给出回滚建议时使用。", "card_url": "https://agents.example.com/deploy-bot/card", "auth_type": "bearer", "streaming": true, @@ -21815,7 +21816,6 @@ "team_id": 0, "can_edit": true, "agent_name": "deploy-bot", - "description": "Remote agent that inspects deployment pipelines.", "card_url": "https://agents.example.com/deploy-bot/card", "auth_type": "bearer", "streaming": true, @@ -21830,7 +21830,8 @@ "auth_mode": "shared", "created_by": 80011, "created_at": 1716960000000, - "updated_at": 1717046400000 + "updated_at": 1717046400000, + "instructions": "Remote agent that inspects deployment pipelines." } ], "total": 1 @@ -21917,7 +21918,6 @@ "team_id": 0, "can_edit": true, "agent_name": "deploy-bot", - "description": "Remote agent that inspects deployment pipelines.", "card_url": "https://agents.example.com/deploy-bot/card", "auth_type": "bearer", "streaming": true, @@ -21932,7 +21932,8 @@ "auth_mode": "shared", "created_by": 80011, "created_at": 1716960000000, - "updated_at": 1717046400000 + "updated_at": 1717046400000, + "instructions": "Remote agent that inspects deployment pipelines." } } } @@ -22039,7 +22040,7 @@ }, "example": { "agent_id": "a2a_6mWqZ2pK9nLcR3tY8uVb4D", - "description": "Inspects deployment pipelines and proposes rollbacks." + "instructions": "检查部署流水线并给出回滚步骤。" } } } @@ -42248,9 +42249,9 @@ "type": "string", "description": "智能体显示名称。" }, - "description": { + "instructions": { "type": "string", - "description": "智能体描述。" + "description": "调用说明，会进入 AI SRE 的系统提示词，用于判断何时调用此 A2A 智能体。" }, "card_url": { "type": "string", @@ -42337,7 +42338,7 @@ "team_id", "can_edit", "agent_name", - "description", + "instructions", "card_url", "auth_type", "streaming", @@ -42365,12 +42366,12 @@ "description": "新的显示名称。省略则不变。", "maxLength": 128 }, - "description": { + "instructions": { "type": [ "string", "null" ], - "description": "新的描述。省略则不变。", + "description": "新的调用说明。省略则不变；传入时不能为空。", "maxLength": 2000 }, "card_url": { @@ -42444,9 +42445,9 @@ "description": "智能体显示名称。", "maxLength": 128 }, - "description": { + "instructions": { "type": "string", - "description": "智能体描述。", + "description": "调用说明，会进入 AI SRE 的系统提示词，用于判断何时调用此 A2A 智能体。不能为空。", "maxLength": 2000 }, "card_url": { @@ -42488,6 +42489,7 @@ }, "required": [ "agent_name", + "instructions", "card_url" ] }, diff --git a/api-reference/safari.openapi.en.json b/api-reference/safari.openapi.en.json index a8d11b6..8ddb679 100644 --- a/api-reference/safari.openapi.en.json +++ b/api-reference/safari.openapi.en.json @@ -1414,6 +1414,7 @@ }, "example": { "agent_name": "deploy-bot", + "instructions": "Use when deployment pipelines need inspection or rollback advice.", "card_url": "https://agents.example.com/deploy-bot/card", "auth_type": "bearer", "streaming": true, @@ -1474,7 +1475,6 @@ "team_id": 0, "can_edit": true, "agent_name": "deploy-bot", - "description": "Remote agent that inspects deployment pipelines.", "card_url": "https://agents.example.com/deploy-bot/card", "auth_type": "bearer", "streaming": true, @@ -1489,7 +1489,8 @@ "auth_mode": "shared", "created_by": 80011, "created_at": 1716960000000, - "updated_at": 1717046400000 + "updated_at": 1717046400000, + "instructions": "Remote agent that inspects deployment pipelines." } ], "total": 1 @@ -1576,7 +1577,6 @@ "team_id": 0, "can_edit": true, "agent_name": "deploy-bot", - "description": "Remote agent that inspects deployment pipelines.", "card_url": "https://agents.example.com/deploy-bot/card", "auth_type": "bearer", "streaming": true, @@ -1591,7 +1591,8 @@ "auth_mode": "shared", "created_by": 80011, "created_at": 1716960000000, - "updated_at": 1717046400000 + "updated_at": 1717046400000, + "instructions": "Remote agent that inspects deployment pipelines." } } } @@ -1698,7 +1699,7 @@ }, "example": { "agent_id": "a2a_6mWqZ2pK9nLcR3tY8uVb4D", - "description": "Inspects deployment pipelines and proposes rollbacks." + "instructions": "Inspect deployment pipelines and propose rollback steps." } } } @@ -3283,9 +3284,9 @@ "type": "string", "description": "Agent display name." }, - "description": { + "instructions": { "type": "string", - "description": "Agent description.", + "description": "Invocation instructions included in AI SRE's system prompt to decide when to call this A2A agent.", "maxLength": 2000 }, "card_url": { @@ -3373,7 +3374,7 @@ "team_id", "can_edit", "agent_name", - "description", + "instructions", "card_url", "auth_type", "streaming", @@ -3394,9 +3395,9 @@ "description": "Agent display name.", "maxLength": 128 }, - "description": { + "instructions": { "type": "string", - "description": "Agent description.", + "description": "Invocation instructions included in AI SRE's system prompt to decide when to call this A2A agent. Must be nonblank.", "maxLength": 2000 }, "card_url": { @@ -3438,6 +3439,7 @@ }, "required": [ "agent_name", + "instructions", "card_url" ] }, @@ -3514,12 +3516,12 @@ "description": "New display name. Omit to leave unchanged.", "maxLength": 128 }, - "description": { + "instructions": { "type": [ "string", "null" ], - "description": "New description. Omit to leave unchanged.", + "description": "New invocation instructions. Omit to leave unchanged; when supplied, must be nonblank.", "maxLength": 2000 }, "card_url": { diff --git a/api-reference/safari.openapi.zh.json b/api-reference/safari.openapi.zh.json index 3064b4c..553fb70 100644 --- a/api-reference/safari.openapi.zh.json +++ b/api-reference/safari.openapi.zh.json @@ -1414,6 +1414,7 @@ }, "example": { "agent_name": "deploy-bot", + "instructions": "当需要检查部署流水线或给出回滚建议时使用。", "card_url": "https://agents.example.com/deploy-bot/card", "auth_type": "bearer", "streaming": true, @@ -1474,7 +1475,6 @@ "team_id": 0, "can_edit": true, "agent_name": "deploy-bot", - "description": "Remote agent that inspects deployment pipelines.", "card_url": "https://agents.example.com/deploy-bot/card", "auth_type": "bearer", "streaming": true, @@ -1489,7 +1489,8 @@ "auth_mode": "shared", "created_by": 80011, "created_at": 1716960000000, - "updated_at": 1717046400000 + "updated_at": 1717046400000, + "instructions": "Remote agent that inspects deployment pipelines." } ], "total": 1 @@ -1576,7 +1577,6 @@ "team_id": 0, "can_edit": true, "agent_name": "deploy-bot", - "description": "Remote agent that inspects deployment pipelines.", "card_url": "https://agents.example.com/deploy-bot/card", "auth_type": "bearer", "streaming": true, @@ -1591,7 +1591,8 @@ "auth_mode": "shared", "created_by": 80011, "created_at": 1716960000000, - "updated_at": 1717046400000 + "updated_at": 1717046400000, + "instructions": "Remote agent that inspects deployment pipelines." } } } @@ -1698,7 +1699,7 @@ }, "example": { "agent_id": "a2a_6mWqZ2pK9nLcR3tY8uVb4D", - "description": "Inspects deployment pipelines and proposes rollbacks." + "instructions": "检查部署流水线并给出回滚步骤。" } } } @@ -3283,9 +3284,9 @@ "type": "string", "description": "智能体显示名称。" }, - "description": { + "instructions": { "type": "string", - "description": "智能体描述。", + "description": "调用说明，会进入 AI SRE 的系统提示词，用于判断何时调用此 A2A 智能体。", "maxLength": 2000 }, "card_url": { @@ -3373,7 +3374,7 @@ "team_id", "can_edit", "agent_name", - "description", + "instructions", "card_url", "auth_type", "streaming", @@ -3394,9 +3395,9 @@ "description": "智能体显示名称。", "maxLength": 128 }, - "description": { + "instructions": { "type": "string", - "description": "智能体描述。", + "description": "调用说明，会进入 AI SRE 的系统提示词，用于判断何时调用此 A2A 智能体。不能为空。", "maxLength": 2000 }, "card_url": { @@ -3438,6 +3439,7 @@ }, "required": [ "agent_name", + "instructions", "card_url" ] }, @@ -3514,12 +3516,12 @@ "description": "新的显示名称。省略则不变。", "maxLength": 128 }, - "description": { + "instructions": { "type": [ "string", "null" ], - "description": "新的描述。省略则不变。", + "description": "新的调用说明。省略则不变；传入时不能为空。", "maxLength": 2000 }, "card_url": {