@azure-devops/mcp 0.1.0 → 0.2.0-preview-oauth

package/dist/tools/search.js

@@ -1,142 +1,155 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 import { z } from "zod";
-import { apiVersion, userAgent } from "../utils.js";
+import { apiVersion } from "../utils.js";
 import { orgName } from "../index.js";
 import { VersionControlRecursionType } from "azure-devops-node-api/interfaces/GitInterfaces.js";
 const SEARCH_TOOLS = {
     search_code: "search_code",
     search_wiki: "search_wiki",
-    search_workitem: "search_workitem"
+    search_workitem: "search_workitem",
 };
-function configureSearchTools(server, tokenProvider, connectionProvider) {
-    /*
-      CODE SEARCH
-      Get the code search results for a given search text.
-    */
-    server.tool(SEARCH_TOOLS.search_code, "Get the code search results for a given search text.", {
-        searchRequest: z.object({
-            searchText: z.string().describe("Search text to find in code"),
-            $skip: z.number().default(0).describe("Number of results to skip (for pagination)"),
-            $top: z.number().default(5).describe("Number of results to return (for pagination)"),
-            filters: z.object({
-                Project: z.array(z.string()).optional().describe("Filter in these projects"),
-                Repository: z.array(z.string()).optional().describe("Filter in these repositories"),
-                Path: z.array(z.string()).optional().describe("Filter in these paths"),
-                Branch: z.array(z.string()).optional().describe("Filter in these branches"),
-                CodeElement: z.array(z.string()).optional().describe("Filter for these code elements (e.g., classes, functions, symbols)"),
-                // Note: CodeElement is optional and can be used to filter results by specific code elements.
-                // It can be a string or an array of strings.
-                // If provided, the search will only return results that match the specified code elements.
-                // This is useful for narrowing down the search to specific classes, functions, definitions, or symbols.
-                // Example: CodeElement: ["MyClass", "MyFunction"]
-            }).partial().optional(),
-            includeFacets: z.boolean().optional()
-        }).strict()
-    }, async ({ searchRequest }) => {
+function configureSearchTools(server, tokenProvider, connectionProvider, userAgentProvider) {
+    server.tool(SEARCH_TOOLS.search_code, "Search Azure DevOps Repositories for a given search text", {
+        searchText: z.string().describe("Keywords to search for in code repositories"),
+        project: z.array(z.string()).optional().describe("Filter by projects"),
+        repository: z.array(z.string()).optional().describe("Filter by repositories"),
+        path: z.array(z.string()).optional().describe("Filter by paths"),
+        branch: z.array(z.string()).optional().describe("Filter by branches"),
+        includeFacets: z.boolean().default(false).describe("Include facets in the search results"),
+        skip: z.number().default(0).describe("Number of results to skip"),
+        top: z.number().default(5).describe("Maximum number of results to return"),
+    }, async ({ searchText, project, repository, path, branch, includeFacets, skip, top }) => {
         const accessToken = await tokenProvider();
         const connection = await connectionProvider();
         const url = `https://almsearch.dev.azure.com/${orgName}/_apis/search/codesearchresults?api-version=${apiVersion}`;
+        const requestBody = {
+            searchText,
+            includeFacets,
+            $skip: skip,
+            $top: top,
+        };
+        const filters = {};
+        if (project && project.length > 0)
+            filters.Project = project;
+        if (repository && repository.length > 0)
+            filters.Repository = repository;
+        if (path && path.length > 0)
+            filters.Path = path;
+        if (branch && branch.length > 0)
+            filters.Branch = branch;
+        if (Object.keys(filters).length > 0) {
+            requestBody.filters = filters;
+        }
         const response = await fetch(url, {
             method: "POST",
             headers: {
                 "Content-Type": "application/json",
-                Authorization: `Bearer ${accessToken.token}`,
-                "User-Agent": `${userAgent}`
+                "Authorization": `Bearer ${accessToken}`,
+                "User-Agent": userAgentProvider(),
             },
-            body: JSON.stringify(searchRequest),
+            body: JSON.stringify(requestBody),
         });
         if (!response.ok) {
             throw new Error(`Azure DevOps Code Search API error: ${response.status} ${response.statusText}`);
         }
         const resultText = await response.text();
         const resultJson = JSON.parse(resultText);
-        const topResults = Array.isArray(resultJson.results)
-            ? resultJson.results.slice(0, Math.min(searchRequest.$top, resultJson.results.length))
-            : [];
         const gitApi = await connection.getGitApi();
-        const combinedResults = await fetchCombinedResults(topResults, gitApi);
+        const combinedResults = await fetchCombinedResults(resultJson.results ?? [], gitApi);
         return {
-            content: [
-                { type: "text", text: resultText + JSON.stringify(combinedResults) }
-            ]
+            content: [{ type: "text", text: resultText + JSON.stringify(combinedResults) }],
         };
     });
-    /*
-      WIKI SEARCH
-      Get wiki search results for a given search text.
-    */
-    server.tool(SEARCH_TOOLS.search_wiki, "Get wiki search results for a given search text.", {
-        searchRequest: z.object({
-            searchText: z.string().describe("Search text to find in wikis"),
-            $skip: z.number().default(0).describe("Number of results to skip (for pagination)"),
-            $top: z.number().default(10).describe("Number of results to return (for pagination)"),
-            filters: z.object({
-                Project: z.array(z.string()).optional().describe("Filter in these projects"),
-                Wiki: z.array(z.string()).optional().describe("Filter in these wiki names"),
-            }).partial().optional().describe("Filters to apply to the search text"),
-            includeFacets: z.boolean().optional()
-        }).strict()
-    }, async ({ searchRequest }) => {
+    server.tool(SEARCH_TOOLS.search_wiki, "Search Azure DevOps Wiki for a given search text", {
+        searchText: z.string().describe("Keywords to search for wiki pages"),
+        project: z.array(z.string()).optional().describe("Filter by projects"),
+        wiki: z.array(z.string()).optional().describe("Filter by wiki names"),
+        includeFacets: z.boolean().default(false).describe("Include facets in the search results"),
+        skip: z.number().default(0).describe("Number of results to skip"),
+        top: z.number().default(10).describe("Maximum number of results to return"),
+    }, async ({ searchText, project, wiki, includeFacets, skip, top }) => {
         const accessToken = await tokenProvider();
         const url = `https://almsearch.dev.azure.com/${orgName}/_apis/search/wikisearchresults?api-version=${apiVersion}`;
+        const requestBody = {
+            searchText,
+            includeFacets,
+            $skip: skip,
+            $top: top,
+        };
+        const filters = {};
+        if (project && project.length > 0)
+            filters.Project = project;
+        if (wiki && wiki.length > 0)
+            filters.Wiki = wiki;
+        if (Object.keys(filters).length > 0) {
+            requestBody.filters = filters;
+        }
         const response = await fetch(url, {
             method: "POST",
             headers: {
                 "Content-Type": "application/json",
-                Authorization: `Bearer ${accessToken.token}`,
-                "User-Agent": `${userAgent}`
+                "Authorization": `Bearer ${accessToken}`,
+                "User-Agent": userAgentProvider(),
             },
-            body: JSON.stringify(searchRequest),
+            body: JSON.stringify(requestBody),
         });
         if (!response.ok) {
             throw new Error(`Azure DevOps Wiki Search API error: ${response.status} ${response.statusText}`);
         }
         const result = await response.text();
         return {
-            content: [
-                { type: "text", text: result }
-            ]
+            content: [{ type: "text", text: result }],
         };
     });
-    /*
-      WORK ITEM SEARCH
-      Get work item search results for a given search text.
-    */
-    server.tool(SEARCH_TOOLS.search_workitem, "Get work item search results for a given search text.", {
-        searchRequest: z.object({
-            searchText: z.string().describe("Search text to find in work items"),
-            $skip: z.number().default(0).describe("Number of results to skip for pagination"),
-            $top: z.number().default(10).describe("Number of results to return"),
-            filters: z.object({
-                "System.TeamProject": z.array(z.string()).optional().describe("Filter by team project"),
-                "System.AreaPath": z.array(z.string()).optional().describe("Filter by area path"),
-                "System.WorkItemType": z.array(z.string()).optional().describe("Filter by work item type like Bug, Task, User Story"),
-                "System.State": z.array(z.string()).optional().describe("Filter by state"),
-                "System.AssignedTo": z.array(z.string()).optional().describe("Filter by assigned to"),
-            }).partial().optional(),
-            includeFacets: z.boolean().optional()
-        }).strict()
-    }, async ({ searchRequest }) => {
+    server.tool(SEARCH_TOOLS.search_workitem, "Get Azure DevOps Work Item search results for a given search text", {
+        searchText: z.string().describe("Search text to find in work items"),
+        project: z.array(z.string()).optional().describe("Filter by projects"),
+        areaPath: z.array(z.string()).optional().describe("Filter by area paths"),
+        workItemType: z.array(z.string()).optional().describe("Filter by work item types"),
+        state: z.array(z.string()).optional().describe("Filter by work item states"),
+        assignedTo: z.array(z.string()).optional().describe("Filter by assigned to users"),
+        includeFacets: z.boolean().default(false).describe("Include facets in the search results"),
+        skip: z.number().default(0).describe("Number of results to skip for pagination"),
+        top: z.number().default(10).describe("Number of results to return"),
+    }, async ({ searchText, project, areaPath, workItemType, state, assignedTo, includeFacets, skip, top }) => {
         const accessToken = await tokenProvider();
         const url = `https://almsearch.dev.azure.com/${orgName}/_apis/search/workitemsearchresults?api-version=${apiVersion}`;
+        const requestBody = {
+            searchText,
+            includeFacets,
+            $skip: skip,
+            $top: top,
+        };
+        const filters = {};
+        if (project && project.length > 0)
+            filters["System.TeamProject"] = project;
+        if (areaPath && areaPath.length > 0)
+            filters["System.AreaPath"] = areaPath;
+        if (workItemType && workItemType.length > 0)
+            filters["System.WorkItemType"] = workItemType;
+        if (state && state.length > 0)
+            filters["System.State"] = state;
+        if (assignedTo && assignedTo.length > 0)
+            filters["System.AssignedTo"] = assignedTo;
+        if (Object.keys(filters).length > 0) {
+            requestBody.filters = filters;
+        }
         const response = await fetch(url, {
             method: "POST",
             headers: {
                 "Content-Type": "application/json",
-                Authorization: `Bearer ${accessToken.token}`,
-                "User-Agent": `${userAgent}`
+                "Authorization": `Bearer ${accessToken}`,
+                "User-Agent": userAgentProvider(),
             },
-            body: JSON.stringify(searchRequest),
+            body: JSON.stringify(requestBody),
         });
         if (!response.ok) {
             throw new Error(`Azure DevOps Work Item Search API error: ${response.status} ${response.statusText}`);
         }
         const result = await response.text();
         return {
-            content: [
-                { type: "text", text: result }
-            ]
+            content: [{ type: "text", text: result }],
         };
     });
 }
@@ -154,9 +167,7 @@ async function fetchCombinedResults(topSearchResults, gitApi) {
                 });
                 continue;
             }
-            const versionDescriptor = changeId
-                ? { version: changeId, versionType: 2, versionOptions: 0 }
-                : undefined;
+            const versionDescriptor = changeId ? { version: changeId, versionType: 2, versionOptions: 0 } : undefined;
             const item = await gitApi.getItem(repositoryId, filePath, projectId, undefined, VersionControlRecursionType.None, true, // includeContentMetadata
             false, // latestProcessedChange
             false, // download
@@ -165,12 +176,12 @@ async function fetchCombinedResults(topSearchResults, gitApi) {
             true // sanitize
             );
             combinedResults.push({
-                gitItem: item
+                gitItem: item,
             });
         }
         catch (err) {
             combinedResults.push({
-                error: err instanceof Error ? err.message : String(err)
+                error: err instanceof Error ? err.message : String(err),
             });
         }
     }

package/dist/tools/test-plans.js

@@ -0,0 +1,213 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+import { z } from "zod";
+const Test_Plan_Tools = {
+    create_test_plan: "testplan_create_test_plan",
+    create_test_case: "testplan_create_test_case",
+    add_test_cases_to_suite: "testplan_add_test_cases_to_suite",
+    test_results_from_build_id: "testplan_show_test_results_from_build_id",
+    list_test_cases: "testplan_list_test_cases",
+    list_test_plans: "testplan_list_test_plans",
+};
+function configureTestPlanTools(server, _, connectionProvider) {
+    /*
+      LIST OF TEST PLANS
+      get list of test plans by project
+    */
+    server.tool(Test_Plan_Tools.list_test_plans, "Retrieve a paginated list of test plans from an Azure DevOps project. Allows filtering for active plans and toggling detailed information.", {
+        project: z.string().describe("The unique identifier (ID or name) of the Azure DevOps project."),
+        filterActivePlans: z.boolean().default(true).describe("Filter to include only active test plans. Defaults to true."),
+        includePlanDetails: z.boolean().default(false).describe("Include detailed information about each test plan."),
+        continuationToken: z.string().optional().describe("Token to continue fetching test plans from a previous request."),
+    }, async ({ project, filterActivePlans, includePlanDetails, continuationToken }) => {
+        const owner = ""; //making owner an empty string untill we can figure out how to get owner id
+        const connection = await connectionProvider();
+        const testPlanApi = await connection.getTestPlanApi();
+        const testPlans = await testPlanApi.getTestPlans(project, owner, continuationToken, includePlanDetails, filterActivePlans);
+        return {
+            content: [{ type: "text", text: JSON.stringify(testPlans, null, 2) }],
+        };
+    });
+    /*
+      Create Test Plan - CREATE
+    */
+    server.tool(Test_Plan_Tools.create_test_plan, "Creates a new test plan in the project.", {
+        project: z.string().describe("The unique identifier (ID or name) of the Azure DevOps project where the test plan will be created."),
+        name: z.string().describe("The name of the test plan to be created."),
+        iteration: z.string().describe("The iteration path for the test plan"),
+        description: z.string().optional().describe("The description of the test plan"),
+        startDate: z.string().optional().describe("The start date of the test plan"),
+        endDate: z.string().optional().describe("The end date of the test plan"),
+        areaPath: z.string().optional().describe("The area path for the test plan"),
+    }, async ({ project, name, iteration, description, startDate, endDate, areaPath }) => {
+        const connection = await connectionProvider();
+        const testPlanApi = await connection.getTestPlanApi();
+        const testPlanToCreate = {
+            name,
+            iteration,
+            description,
+            startDate: startDate ? new Date(startDate) : undefined,
+            endDate: endDate ? new Date(endDate) : undefined,
+            areaPath,
+        };
+        const createdTestPlan = await testPlanApi.createTestPlan(testPlanToCreate, project);
+        return {
+            content: [{ type: "text", text: JSON.stringify(createdTestPlan, null, 2) }],
+        };
+    });
+    /*
+      Add Test Cases to Suite - ADD
+    */
+    server.tool(Test_Plan_Tools.add_test_cases_to_suite, "Adds existing test cases to a test suite.", {
+        project: z.string().describe("The unique identifier (ID or name) of the Azure DevOps project."),
+        planId: z.number().describe("The ID of the test plan."),
+        suiteId: z.number().describe("The ID of the test suite."),
+        testCaseIds: z.string().or(z.array(z.string())).describe("The ID(s) of the test case(s) to add. "),
+    }, async ({ project, planId, suiteId, testCaseIds }) => {
+        const connection = await connectionProvider();
+        const testApi = await connection.getTestApi();
+        // If testCaseIds is an array, convert it to comma-separated string
+        const testCaseIdsString = Array.isArray(testCaseIds) ? testCaseIds.join(",") : testCaseIds;
+        const addedTestCases = await testApi.addTestCasesToSuite(project, planId, suiteId, testCaseIdsString);
+        return {
+            content: [{ type: "text", text: JSON.stringify(addedTestCases, null, 2) }],
+        };
+    });
+    /*
+      Create Test Case - CREATE
+    */
+    server.tool(Test_Plan_Tools.create_test_case, "Creates a new test case work item.", {
+        project: z.string().describe("The unique identifier (ID or name) of the Azure DevOps project."),
+        title: z.string().describe("The title of the test case."),
+        steps: z
+            .string()
+            .optional()
+            .describe("The steps to reproduce the test case. Make sure to format each step as '1. Step one|Expected result one\n2. Step two|Expected result two. USE '|' as the delimiter between step and expected result. DO NOT use '|' in the description of the step or expected result."),
+        priority: z.number().optional().describe("The priority of the test case."),
+        areaPath: z.string().optional().describe("The area path for the test case."),
+        iterationPath: z.string().optional().describe("The iteration path for the test case."),
+    }, async ({ project, title, steps, priority, areaPath, iterationPath }) => {
+        const connection = await connectionProvider();
+        const witClient = await connection.getWorkItemTrackingApi();
+        let stepsXml;
+        if (steps) {
+            stepsXml = convertStepsToXml(steps);
+        }
+        // Create JSON patch document for work item
+        const patchDocument = [];
+        patchDocument.push({
+            op: "add",
+            path: "/fields/System.Title",
+            value: title,
+        });
+        if (stepsXml) {
+            patchDocument.push({
+                op: "add",
+                path: "/fields/Microsoft.VSTS.TCM.Steps",
+                value: stepsXml,
+            });
+        }
+        if (priority) {
+            patchDocument.push({
+                op: "add",
+                path: "/fields/Microsoft.VSTS.Common.Priority",
+                value: priority,
+            });
+        }
+        if (areaPath) {
+            patchDocument.push({
+                op: "add",
+                path: "/fields/System.AreaPath",
+                value: areaPath,
+            });
+        }
+        if (iterationPath) {
+            patchDocument.push({
+                op: "add",
+                path: "/fields/System.IterationPath",
+                value: iterationPath,
+            });
+        }
+        const workItem = await witClient.createWorkItem({}, patchDocument, project, "Test Case");
+        return {
+            content: [{ type: "text", text: JSON.stringify(workItem, null, 2) }],
+        };
+    });
+    /*
+      TEST PLANS
+      Gets a list of test cases for a given testplan.
+    */
+    server.tool(Test_Plan_Tools.list_test_cases, "Gets a list of test cases in the test plan.", {
+        project: z.string().describe("The unique identifier (ID or name) of the Azure DevOps project."),
+        planid: z.number().describe("The ID of the test plan."),
+        suiteid: z.number().describe("The ID of the test suite."),
+    }, async ({ project, planid, suiteid }) => {
+        const connection = await connectionProvider();
+        const coreApi = await connection.getTestPlanApi();
+        const testcases = await coreApi.getTestCaseList(project, planid, suiteid);
+        return {
+            content: [{ type: "text", text: JSON.stringify(testcases, null, 2) }],
+        };
+    });
+    /*
+      Gets a list of test results for a given project and build ID
+    */
+    server.tool(Test_Plan_Tools.test_results_from_build_id, "Gets a list of test results for a given project and build ID.", {
+        project: z.string().describe("The unique identifier (ID or name) of the Azure DevOps project."),
+        buildid: z.number().describe("The ID of the build."),
+    }, async ({ project, buildid }) => {
+        const connection = await connectionProvider();
+        const coreApi = await connection.getTestResultsApi();
+        const testResults = await coreApi.getTestResultDetailsForBuild(project, buildid);
+        return {
+            content: [{ type: "text", text: JSON.stringify(testResults, null, 2) }],
+        };
+    });
+}
+/*
+ * Helper function to convert steps text to XML format required
+ */
+function convertStepsToXml(steps) {
+    // Accepts steps in the format: '1. Step one|Expected result one\n2. Step two|Expected result two'
+    const stepsLines = steps.split("\n").filter((line) => line.trim() !== "");
+    let xmlSteps = `<steps id="0" last="${stepsLines.length}">`;
+    for (let i = 0; i < stepsLines.length; i++) {
+        const stepLine = stepsLines[i].trim();
+        if (stepLine) {
+            // Split step and expected result by '|', fallback to default if not provided
+            const [stepPart, expectedPart] = stepLine.split("|").map((s) => s.trim());
+            const stepMatch = stepPart.match(/^(\d+)\.\s*(.+)$/);
+            const stepText = stepMatch ? stepMatch[2] : stepPart;
+            const expectedText = expectedPart || "Verify step completes successfully";
+            xmlSteps += `
+                <step id="${i + 1}" type="ActionStep">
+                    <parameterizedString isformatted="true">${escapeXml(stepText)}</parameterizedString>
+                    <parameterizedString isformatted="true">${escapeXml(expectedText)}</parameterizedString>
+                </step>`;
+        }
+    }
+    xmlSteps += "</steps>";
+    return xmlSteps;
+}
+/*
+ * Helper function to escape XML special characters
+ */
+function escapeXml(unsafe) {
+    return unsafe.replace(/[<>&'"]/g, (c) => {
+        switch (c) {
+            case "<":
+                return "&lt;";
+            case ">":
+                return "&gt;";
+            case "&":
+                return "&amp;";
+            case "'":
+                return "&apos;";
+            case '"':
+                return "&quot;";
+            default:
+                return c;
+        }
+    });
+}
+export { Test_Plan_Tools, configureTestPlanTools };

package/dist/tools/testplans.js

@@ -7,7 +7,7 @@ const Test_Plan_Tools = {
     add_test_cases_to_suite: "testplan_add_test_cases_to_suite",
     test_results_from_build_id: "testplan_show_test_results_from_build_id",
     list_test_cases: "testplan_list_test_cases",
-    list_test_plans: "testplan_list_test_plans"
+    list_test_plans: "testplan_list_test_plans",
 };
 function configureTestPlanTools(server, tokenProvider, connectionProvider) {
     /*
@@ -19,7 +19,7 @@ function configureTestPlanTools(server, tokenProvider, connectionProvider) {
         filterActivePlans: z.boolean().default(true).describe("Filter to include only active test plans. Defaults to true."),
         includePlanDetails: z.boolean().default(false).describe("Include detailed information about each test plan."),
         continuationToken: z.string().optional().describe("Token to continue fetching test plans from a previous request."),
-    }, async ({ project, filterActivePlans, includePlanDetails, continuationToken, }) => {
+    }, async ({ project, filterActivePlans, includePlanDetails, continuationToken }) => {
         const owner = ""; //making owner an empty string untill we can figure out how to get owner id
         const connection = await connectionProvider();
         const testPlanApi = await connection.getTestPlanApi();
@@ -39,7 +39,7 @@ function configureTestPlanTools(server, tokenProvider, connectionProvider) {
         startDate: z.string().optional().describe("The start date of the test plan"),
         endDate: z.string().optional().describe("The end date of the test plan"),
         areaPath: z.string().optional().describe("The area path for the test plan"),
-    }, async ({ project, name, iteration, description, startDate, endDate, areaPath, }) => {
+    }, async ({ project, name, iteration, description, startDate, endDate, areaPath }) => {
         const connection = await connectionProvider();
         const testPlanApi = await connection.getTestPlanApi();
         const testPlanToCreate = {
@@ -52,9 +52,7 @@ function configureTestPlanTools(server, tokenProvider, connectionProvider) {
         };
         const createdTestPlan = await testPlanApi.createTestPlan(testPlanToCreate, project);
         return {
-            content: [
-                { type: "text", text: JSON.stringify(createdTestPlan, null, 2) },
-            ],
+            content: [{ type: "text", text: JSON.stringify(createdTestPlan, null, 2) }],
         };
     });
     /*
@@ -69,14 +67,10 @@ function configureTestPlanTools(server, tokenProvider, connectionProvider) {
         const connection = await connectionProvider();
         const testApi = await connection.getTestApi();
         // If testCaseIds is an array, convert it to comma-separated string
-        const testCaseIdsString = Array.isArray(testCaseIds)
-            ? testCaseIds.join(",")
-            : testCaseIds;
+        const testCaseIdsString = Array.isArray(testCaseIds) ? testCaseIds.join(",") : testCaseIds;
         const addedTestCases = await testApi.addTestCasesToSuite(project, planId, suiteId, testCaseIdsString);
         return {
-            content: [
-                { type: "text", text: JSON.stringify(addedTestCases, null, 2) },
-            ],
+            content: [{ type: "text", text: JSON.stringify(addedTestCases, null, 2) }],
         };
     });
     /*
@@ -85,7 +79,10 @@ function configureTestPlanTools(server, tokenProvider, connectionProvider) {
     server.tool(Test_Plan_Tools.create_test_case, "Creates a new test case work item.", {
         project: z.string().describe("The unique identifier (ID or name) of the Azure DevOps project."),
         title: z.string().describe("The title of the test case."),
-        steps: z.string().optional().describe("The steps to reproduce the test case. Make sure to format each step as '1. Step one\\n2. Step two' etc."),
+        steps: z
+            .string()
+            .optional()
+            .describe("The steps to reproduce the test case. Make sure to format each step as '1. Step one|Expected result one\n2. Step two|Expected result two. USE '|' as the delimiter between step and expected result. DO NOT use '|' in the description of the step or expected result."),
         priority: z.number().optional().describe("The priority of the test case."),
         areaPath: z.string().optional().describe("The area path for the test case."),
         iterationPath: z.string().optional().describe("The iteration path for the test case."),
@@ -169,19 +166,23 @@ function configureTestPlanTools(server, tokenProvider, connectionProvider) {
 }
 /*
  * Helper function to convert steps text to XML format required
-*/
+ */
 function convertStepsToXml(steps) {
+    // Accepts steps in the format: '1. Step one|Expected result one\n2. Step two|Expected result two'
     const stepsLines = steps.split("\n").filter((line) => line.trim() !== "");
     let xmlSteps = `<steps id="0" last="${stepsLines.length}">`;
     for (let i = 0; i < stepsLines.length; i++) {
         const stepLine = stepsLines[i].trim();
         if (stepLine) {
-            const stepMatch = stepLine.match(/^(\d+)\.\s*(.+)$/);
-            const stepText = stepMatch ? stepMatch[2] : stepLine;
-            xmlSteps += `
-                <step id="${i + 1}" type="ActionStep">
-                    <parameterizedString isformatted="true">${escapeXml(stepText)}</parameterizedString>
-                    <parameterizedString isformatted="true">Verify step completes successfully</parameterizedString>
+            // Split step and expected result by '|', fallback to default if not provided
+            const [stepPart, expectedPart] = stepLine.split("|").map((s) => s.trim());
+            const stepMatch = stepPart.match(/^(\d+)\.\s*(.+)$/);
+            const stepText = stepMatch ? stepMatch[2] : stepPart;
+            const expectedText = expectedPart || "Verify step completes successfully";
+            xmlSteps += `
+                <step id="${i + 1}" type="ActionStep">
+                    <parameterizedString isformatted="true">${escapeXml(stepText)}</parameterizedString>
+                    <parameterizedString isformatted="true">${escapeXml(expectedText)}</parameterizedString>
                 </step>`;
         }
     }
@@ -190,7 +191,7 @@ function convertStepsToXml(steps) {
 }
 /*
  * Helper function to escape XML special characters
-*/
+ */
 function escapeXml(unsafe) {
     return unsafe.replace(/[<>&'"]/g, (c) => {
         switch (c) {