Skip to content

Commit eac1aa6

Browse files
committed
Enhance descriptions for test ID and project/build name inputs in RCA tools
1 parent 7858d84 commit eac1aa6

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

src/tools/rca-agent.ts

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ export default function addRCATools(
101101
.array(z.string())
102102
.max(3)
103103
.describe(
104-
"Array of test IDs to fetch RCA data for (maximum 3 IDs). Use the listTestIds tool to discover available test IDs if needed. If more than 3 IDs are provided, only the first 3 will be processed.",
104+
"Array of test IDs to fetch RCA data for (maximum 3 IDs). If not provided, use the listTestIds tool get all failed testcases. If more than 3 IDs are provided, only the first 3 will be processed.",
105105
),
106106
},
107107
async (args) => {
@@ -126,13 +126,20 @@ export default function addRCATools(
126126
"listTestIds",
127127
"List test IDs from a BrowserStack Automate build, optionally filtered by status",
128128
{
129-
projectName: z.string().describe("The project name of the test run"),
130-
buildName: z.string().describe("The build name of the test run"),
129+
projectName: z
130+
.string()
131+
.describe(
132+
"The Browserstack project name used while creation of test run. Check browserstack.yml or similar project configuration files. If found extract it and provide to user,IF not found or unsure, prompt the user for this value. Do not make assumptions",
133+
),
134+
buildName: z
135+
.string()
136+
.describe(
137+
"The Browserstack build name used while creation of test run. Check browserstack.yml or similar project configuration files. If found extract it and provide to user,IF not found or unsure, prompt the user for this value. Do not make assumptions",
138+
),
131139
status: z
132140
.nativeEnum(TestStatus)
133-
.optional()
134141
.describe(
135-
"Filter tests by status. If not provided, all tests are returned.",
142+
"Filter tests by status. If not provided, all tests are returned. Example for RCA usecase always use failed status",
136143
),
137144
},
138145
async (args) => {

0 commit comments

Comments
 (0)