@azure-devops/mcp 2.2.0-nightly.20250930 → 2.2.0

package/dist/tools/testplans.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, tokenProvider, 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/wiki.js

@@ -1,10 +1,12 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 import { z } from "zod";
+import { apiVersion } from "../utils.js";
 const WIKI_TOOLS = {
     list_wikis: "wiki_list_wikis",
     get_wiki: "wiki_get_wiki",
     list_wiki_pages: "wiki_list_pages",
+    get_wiki_page: "wiki_get_page",
     get_wiki_page_content: "wiki_get_page_content",
     create_or_update_page: "wiki_create_or_update_page",
 };
@@ -85,6 +87,54 @@ function configureWikiTools(server, tokenProvider, connectionProvider, userAgent
             };
         }
     });
+    server.tool(WIKI_TOOLS.get_wiki_page, "Retrieve wiki page metadata by path. This tool does not return page content.", {
+        wikiIdentifier: z.string().describe("The unique identifier of the wiki."),
+        project: z.string().describe("The project name or ID where the wiki is located."),
+        path: z.string().describe("The path of the wiki page (e.g., '/Home' or '/Documentation/Setup')."),
+        recursionLevel: z
+            .enum(["None", "OneLevel", "OneLevelPlusNestedEmptyFolders", "Full"])
+            .optional()
+            .describe("Recursion level for subpages. 'None' returns only the specified page. 'OneLevel' includes direct children. 'Full' includes all descendants."),
+    }, async ({ wikiIdentifier, project, path, recursionLevel }) => {
+        try {
+            const connection = await connectionProvider();
+            const accessToken = await tokenProvider();
+            // Normalize the path
+            const normalizedPath = path.startsWith("/") ? path : `/${path}`;
+            //const encodedPath = encodeURIComponent(normalizedPath);
+            // Build the URL for the wiki page API
+            const baseUrl = connection.serverUrl.replace(/\/$/, "");
+            const params = new URLSearchParams({
+                "path": normalizedPath,
+                "api-version": apiVersion,
+            });
+            if (recursionLevel) {
+                params.append("recursionLevel", recursionLevel);
+            }
+            const url = `${baseUrl}/${project}/_apis/wiki/wikis/${wikiIdentifier}/pages?${params.toString()}`;
+            const response = await fetch(url, {
+                headers: {
+                    "Authorization": `Bearer ${accessToken}`,
+                    "User-Agent": userAgentProvider(),
+                },
+            });
+            if (!response.ok) {
+                const errorText = await response.text();
+                throw new Error(`Failed to get wiki page (${response.status}): ${errorText}`);
+            }
+            const pageData = await response.json();
+            return {
+                content: [{ type: "text", text: JSON.stringify(pageData, null, 2) }],
+            };
+        }
+        catch (error) {
+            const errorMessage = error instanceof Error ? error.message : "Unknown error occurred";
+            return {
+                content: [{ type: "text", text: `Error fetching wiki page metadata: ${errorMessage}` }],
+                isError: true,
+            };
+        }
+    });
     server.tool(WIKI_TOOLS.get_wiki_page_content, "Retrieve wiki page content. Provide either a 'url' parameter OR the combination of 'wikiIdentifier' and 'project' parameters.", {
         url: z
             .string()