@azure-devops/mcp 2.2.2 → 2.3.0-nightly.20251203

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,271 +0,0 @@
1
- // Copyright (c) Microsoft Corporation.
2
- // Licensed under the MIT License.
3
- import { apiVersion, getEnumKeys, safeEnumConvert } from "../utils.js";
4
- import { BuildQueryOrder, DefinitionQueryOrder } from "azure-devops-node-api/interfaces/BuildInterfaces.js";
5
- import { z } from "zod";
6
- import { StageUpdateType } from "azure-devops-node-api/interfaces/BuildInterfaces.js";
7
- const BUILD_TOOLS = {
8
- get_builds: "build_get_builds",
9
- get_changes: "build_get_changes",
10
- get_definitions: "build_get_definitions",
11
- get_definition_revisions: "build_get_definition_revisions",
12
- get_log: "build_get_log",
13
- get_log_by_id: "build_get_log_by_id",
14
- get_status: "build_get_status",
15
- pipelines_get_run: "pipelines_get_run",
16
- pipelines_list_runs: "pipelines_list_runs",
17
- pipelines_run_pipeline: "pipelines_run_pipeline",
18
- update_build_stage: "build_update_build_stage",
19
- };
20
- function configureBuildTools(server, tokenProvider, connectionProvider, userAgentProvider) {
21
- server.tool(BUILD_TOOLS.get_definitions, "Retrieves a list of build definitions for a given project.", {
22
- project: z.string().describe("Project ID or name to get build definitions for"),
23
- repositoryId: z.string().optional().describe("Repository ID to filter build definitions"),
24
- repositoryType: z.enum(["TfsGit", "GitHub", "BitbucketCloud"]).optional().describe("Type of repository to filter build definitions"),
25
- name: z.string().optional().describe("Name of the build definition to filter"),
26
- path: z.string().optional().describe("Path of the build definition to filter"),
27
- queryOrder: z
28
- .enum(getEnumKeys(DefinitionQueryOrder))
29
- .optional()
30
- .describe("Order in which build definitions are returned"),
31
- top: z.number().optional().describe("Maximum number of build definitions to return"),
32
- continuationToken: z.string().optional().describe("Token for continuing paged results"),
33
- minMetricsTime: z.coerce.date().optional().describe("Minimum metrics time to filter build definitions"),
34
- definitionIds: z.array(z.number()).optional().describe("Array of build definition IDs to filter"),
35
- builtAfter: z.coerce.date().optional().describe("Return definitions that have builds after this date"),
36
- notBuiltAfter: z.coerce.date().optional().describe("Return definitions that do not have builds after this date"),
37
- includeAllProperties: z.boolean().optional().describe("Whether to include all properties in the results"),
38
- includeLatestBuilds: z.boolean().optional().describe("Whether to include the latest builds for each definition"),
39
- taskIdFilter: z.string().optional().describe("Task ID to filter build definitions"),
40
- processType: z.number().optional().describe("Process type to filter build definitions"),
41
- yamlFilename: z.string().optional().describe("YAML filename to filter build definitions"),
42
- }, async ({ project, repositoryId, repositoryType, name, path, queryOrder, top, continuationToken, minMetricsTime, definitionIds, builtAfter, notBuiltAfter, includeAllProperties, includeLatestBuilds, taskIdFilter, processType, yamlFilename, }) => {
43
- const connection = await connectionProvider();
44
- const buildApi = await connection.getBuildApi();
45
- const buildDefinitions = await buildApi.getDefinitions(project, name, repositoryId, repositoryType, safeEnumConvert(DefinitionQueryOrder, queryOrder), top, continuationToken, minMetricsTime, definitionIds, path, builtAfter, notBuiltAfter, includeAllProperties, includeLatestBuilds, taskIdFilter, processType, yamlFilename);
46
- return {
47
- content: [{ type: "text", text: JSON.stringify(buildDefinitions, null, 2) }],
48
- };
49
- });
50
- server.tool(BUILD_TOOLS.get_definition_revisions, "Retrieves a list of revisions for a specific build definition.", {
51
- project: z.string().describe("Project ID or name to get the build definition revisions for"),
52
- definitionId: z.number().describe("ID of the build definition to get revisions for"),
53
- }, async ({ project, definitionId }) => {
54
- const connection = await connectionProvider();
55
- const buildApi = await connection.getBuildApi();
56
- const revisions = await buildApi.getDefinitionRevisions(project, definitionId);
57
- return {
58
- content: [{ type: "text", text: JSON.stringify(revisions, null, 2) }],
59
- };
60
- });
61
- server.tool(BUILD_TOOLS.get_builds, "Retrieves a list of builds for a given project.", {
62
- project: z.string().describe("Project ID or name to get builds for"),
63
- definitions: z.array(z.number()).optional().describe("Array of build definition IDs to filter builds"),
64
- queues: z.array(z.number()).optional().describe("Array of queue IDs to filter builds"),
65
- buildNumber: z.string().optional().describe("Build number to filter builds"),
66
- minTime: z.coerce.date().optional().describe("Minimum finish time to filter builds"),
67
- maxTime: z.coerce.date().optional().describe("Maximum finish time to filter builds"),
68
- requestedFor: z.string().optional().describe("User ID or name who requested the build"),
69
- reasonFilter: z.number().optional().describe("Reason filter for the build (see BuildReason enum)"),
70
- statusFilter: z.number().optional().describe("Status filter for the build (see BuildStatus enum)"),
71
- resultFilter: z.number().optional().describe("Result filter for the build (see BuildResult enum)"),
72
- tagFilters: z.array(z.string()).optional().describe("Array of tags to filter builds"),
73
- properties: z.array(z.string()).optional().describe("Array of property names to include in the results"),
74
- top: z.number().optional().describe("Maximum number of builds to return"),
75
- continuationToken: z.string().optional().describe("Token for continuing paged results"),
76
- maxBuildsPerDefinition: z.number().optional().describe("Maximum number of builds per definition"),
77
- deletedFilter: z.number().optional().describe("Filter for deleted builds (see QueryDeletedOption enum)"),
78
- queryOrder: z
79
- .enum(getEnumKeys(BuildQueryOrder))
80
- .default("QueueTimeDescending")
81
- .optional()
82
- .describe("Order in which builds are returned"),
83
- branchName: z.string().optional().describe("Branch name to filter builds"),
84
- buildIds: z.array(z.number()).optional().describe("Array of build IDs to retrieve"),
85
- repositoryId: z.string().optional().describe("Repository ID to filter builds"),
86
- repositoryType: z.enum(["TfsGit", "GitHub", "BitbucketCloud"]).optional().describe("Type of repository to filter builds"),
87
- }, async ({ project, definitions, queues, buildNumber, minTime, maxTime, requestedFor, reasonFilter, statusFilter, resultFilter, tagFilters, properties, top, continuationToken, maxBuildsPerDefinition, deletedFilter, queryOrder, branchName, buildIds, repositoryId, repositoryType, }) => {
88
- const connection = await connectionProvider();
89
- const buildApi = await connection.getBuildApi();
90
- const builds = await buildApi.getBuilds(project, definitions, queues, buildNumber, minTime, maxTime, requestedFor, reasonFilter, statusFilter, resultFilter, tagFilters, properties, top, continuationToken, maxBuildsPerDefinition, deletedFilter, safeEnumConvert(BuildQueryOrder, queryOrder), branchName, buildIds, repositoryId, repositoryType);
91
- return {
92
- content: [{ type: "text", text: JSON.stringify(builds, null, 2) }],
93
- };
94
- });
95
- server.tool(BUILD_TOOLS.get_log, "Retrieves the logs for a specific build.", {
96
- project: z.string().describe("Project ID or name to get the build log for"),
97
- buildId: z.number().describe("ID of the build to get the log for"),
98
- }, async ({ project, buildId }) => {
99
- const connection = await connectionProvider();
100
- const buildApi = await connection.getBuildApi();
101
- const logs = await buildApi.getBuildLogs(project, buildId);
102
- return {
103
- content: [{ type: "text", text: JSON.stringify(logs, null, 2) }],
104
- };
105
- });
106
- server.tool(BUILD_TOOLS.get_log_by_id, "Get a specific build log by log ID.", {
107
- project: z.string().describe("Project ID or name to get the build log for"),
108
- buildId: z.number().describe("ID of the build to get the log for"),
109
- logId: z.number().describe("ID of the log to retrieve"),
110
- startLine: z.number().optional().describe("Starting line number for the log content, defaults to 0"),
111
- endLine: z.number().optional().describe("Ending line number for the log content, defaults to the end of the log"),
112
- }, async ({ project, buildId, logId, startLine, endLine }) => {
113
- const connection = await connectionProvider();
114
- const buildApi = await connection.getBuildApi();
115
- const logLines = await buildApi.getBuildLogLines(project, buildId, logId, startLine, endLine);
116
- return {
117
- content: [{ type: "text", text: JSON.stringify(logLines, null, 2) }],
118
- };
119
- });
120
- server.tool(BUILD_TOOLS.get_changes, "Get the changes associated with a specific build.", {
121
- project: z.string().describe("Project ID or name to get the build changes for"),
122
- buildId: z.number().describe("ID of the build to get changes for"),
123
- continuationToken: z.string().optional().describe("Continuation token for pagination"),
124
- top: z.number().default(100).describe("Number of changes to retrieve, defaults to 100"),
125
- includeSourceChange: z.boolean().optional().describe("Whether to include source changes in the results, defaults to false"),
126
- }, async ({ project, buildId, continuationToken, top, includeSourceChange }) => {
127
- const connection = await connectionProvider();
128
- const buildApi = await connection.getBuildApi();
129
- const changes = await buildApi.getBuildChanges(project, buildId, continuationToken, top, includeSourceChange);
130
- return {
131
- content: [{ type: "text", text: JSON.stringify(changes, null, 2) }],
132
- };
133
- });
134
- server.tool(BUILD_TOOLS.pipelines_get_run, "Gets a run for a particular pipeline.", {
135
- project: z.string().describe("Project ID or name to run the build in"),
136
- pipelineId: z.number().describe("ID of the pipeline to run"),
137
- runId: z.number().describe("ID of the run to get"),
138
- }, async ({ project, pipelineId, runId }) => {
139
- const connection = await connectionProvider();
140
- const pipelinesApi = await connection.getPipelinesApi();
141
- const pipelineRun = await pipelinesApi.getRun(project, pipelineId, runId);
142
- return {
143
- content: [{ type: "text", text: JSON.stringify(pipelineRun, null, 2) }],
144
- };
145
- });
146
- server.tool(BUILD_TOOLS.pipelines_list_runs, "Gets top 10000 runs for a particular pipeline.", {
147
- project: z.string().describe("Project ID or name to run the build in"),
148
- pipelineId: z.number().describe("ID of the pipeline to run"),
149
- }, async ({ project, pipelineId }) => {
150
- const connection = await connectionProvider();
151
- const pipelinesApi = await connection.getPipelinesApi();
152
- const pipelineRuns = await pipelinesApi.listRuns(project, pipelineId);
153
- return {
154
- content: [{ type: "text", text: JSON.stringify(pipelineRuns, null, 2) }],
155
- };
156
- });
157
- const variableSchema = z.object({
158
- value: z.string().optional(),
159
- isSecret: z.boolean().optional(),
160
- });
161
- const resourcesSchema = z.object({
162
- builds: z
163
- .record(z.string().describe("Name of the build resource."), z.object({
164
- version: z.string().optional().describe("Version of the build resource."),
165
- }))
166
- .optional(),
167
- containers: z
168
- .record(z.string().describe("Name of the container resource."), z.object({
169
- version: z.string().optional().describe("Version of the container resource."),
170
- }))
171
- .optional(),
172
- packages: z
173
- .record(z.string().describe("Name of the package resource."), z.object({
174
- version: z.string().optional().describe("Version of the package resource."),
175
- }))
176
- .optional(),
177
- pipelines: z.record(z.string().describe("Name of the pipeline resource."), z.object({
178
- runId: z.number().describe("Id of the source pipeline run that triggered or is referenced by this pipeline run."),
179
- version: z.string().optional().describe("Version of the source pipeline run."),
180
- })),
181
- repositories: z
182
- .record(z.string().describe("Name of the repository resource."), z.object({
183
- refName: z.string().describe("Reference name, e.g., refs/heads/main."),
184
- token: z.string().optional(),
185
- tokenType: z.string().optional(),
186
- version: z.string().optional().describe("Version of the repository resource, git commit sha."),
187
- }))
188
- .optional(),
189
- });
190
- server.tool(BUILD_TOOLS.pipelines_run_pipeline, "Starts a new run of a pipeline.", {
191
- project: z.string().describe("Project ID or name to run the build in"),
192
- pipelineId: z.number().describe("ID of the pipeline to run"),
193
- pipelineVersion: z.number().optional().describe("Version of the pipeline to run. If not provided, the latest version will be used."),
194
- previewRun: z.boolean().optional().describe("If true, returns the final YAML document after parsing templates without creating a new run."),
195
- resources: resourcesSchema.optional().describe("A dictionary of resources to pass to the pipeline."),
196
- stagesToSkip: z.array(z.string()).optional().describe("A list of stages to skip."),
197
- templateParameters: z.record(z.string(), z.string()).optional().describe("Custom build parameters as key-value pairs"),
198
- variables: z.record(z.string(), variableSchema).optional().describe("A dictionary of variables to pass to the pipeline."),
199
- yamlOverride: z.string().optional().describe("YAML override for the pipeline run."),
200
- }, async ({ project, pipelineId, pipelineVersion, previewRun, resources, stagesToSkip, templateParameters, variables, yamlOverride }) => {
201
- if (!previewRun && yamlOverride) {
202
- throw new Error("Parameter 'yamlOverride' can only be specified together with parameter 'previewRun'.");
203
- }
204
- const connection = await connectionProvider();
205
- const pipelinesApi = await connection.getPipelinesApi();
206
- const runRequest = {
207
- previewRun: previewRun,
208
- resources: {
209
- ...resources,
210
- },
211
- stagesToSkip: stagesToSkip,
212
- templateParameters: templateParameters,
213
- variables: variables,
214
- yamlOverride: yamlOverride,
215
- };
216
- const pipelineRun = await pipelinesApi.runPipeline(runRequest, project, pipelineId, pipelineVersion);
217
- const queuedBuild = { id: pipelineRun.id };
218
- const buildId = queuedBuild.id;
219
- if (buildId === undefined) {
220
- throw new Error("Failed to get build ID from pipeline run");
221
- }
222
- return {
223
- content: [{ type: "text", text: JSON.stringify(pipelineRun, null, 2) }],
224
- };
225
- });
226
- server.tool(BUILD_TOOLS.get_status, "Fetches the status of a specific build.", {
227
- project: z.string().describe("Project ID or name to get the build status for"),
228
- buildId: z.number().describe("ID of the build to get the status for"),
229
- }, async ({ project, buildId }) => {
230
- const connection = await connectionProvider();
231
- const buildApi = await connection.getBuildApi();
232
- const build = await buildApi.getBuildReport(project, buildId);
233
- return {
234
- content: [{ type: "text", text: JSON.stringify(build, null, 2) }],
235
- };
236
- });
237
- server.tool(BUILD_TOOLS.update_build_stage, "Updates the stage of a specific build.", {
238
- project: z.string().describe("Project ID or name to update the build stage for"),
239
- buildId: z.number().describe("ID of the build to update"),
240
- stageName: z.string().describe("Name of the stage to update"),
241
- status: z.enum(getEnumKeys(StageUpdateType)).describe("New status for the stage"),
242
- forceRetryAllJobs: z.boolean().default(false).describe("Whether to force retry all jobs in the stage."),
243
- }, async ({ project, buildId, stageName, status, forceRetryAllJobs }) => {
244
- const connection = await connectionProvider();
245
- const orgUrl = connection.serverUrl;
246
- const endpoint = `${orgUrl}/${project}/_apis/build/builds/${buildId}/stages/${stageName}?api-version=${apiVersion}`;
247
- const token = await tokenProvider();
248
- const body = {
249
- forceRetryAllJobs: forceRetryAllJobs,
250
- state: safeEnumConvert(StageUpdateType, status),
251
- };
252
- const response = await fetch(endpoint, {
253
- method: "PATCH",
254
- headers: {
255
- "Content-Type": "application/json",
256
- "Authorization": `Bearer ${token}`,
257
- "User-Agent": userAgentProvider(),
258
- },
259
- body: JSON.stringify(body),
260
- });
261
- if (!response.ok) {
262
- const errorText = await response.text();
263
- throw new Error(`Failed to update build stage: ${response.status} ${errorText}`);
264
- }
265
- const updatedBuild = await response.text();
266
- return {
267
- content: [{ type: "text", text: JSON.stringify(updatedBuild, null, 2) }],
268
- };
269
- });
270
- }
271
- export { BUILD_TOOLS, configureBuildTools };
@@ -1,97 +0,0 @@
1
- // Copyright (c) Microsoft Corporation.
2
- // Licensed under the MIT License.
3
- import { ReleaseDefinitionExpands, ReleaseDefinitionQueryOrder, ReleaseExpands, ReleaseStatus, ReleaseQueryOrder } from "azure-devops-node-api/interfaces/ReleaseInterfaces.js";
4
- import { z } from "zod";
5
- import { getEnumKeys, safeEnumConvert } from "../utils.js";
6
- const RELEASE_TOOLS = {
7
- get_release_definitions: "release_get_definitions",
8
- get_releases: "release_get_releases",
9
- };
10
- function configureReleaseTools(server, _, connectionProvider) {
11
- server.tool(RELEASE_TOOLS.get_release_definitions, "Retrieves list of release definitions for a given project.", {
12
- project: z.string().describe("Project ID or name to get release definitions for"),
13
- searchText: z.string().optional().describe("Search text to filter release definitions"),
14
- expand: z
15
- .enum(getEnumKeys(ReleaseDefinitionExpands))
16
- .default("None")
17
- .describe("Expand options for release definitions"),
18
- artifactType: z.string().optional().describe("Filter by artifact type"),
19
- artifactSourceId: z.string().optional().describe("Filter by artifact source ID"),
20
- top: z.number().optional().describe("Number of results to return (for pagination)"),
21
- continuationToken: z.string().optional().describe("Continuation token for pagination"),
22
- queryOrder: z
23
- .enum(getEnumKeys(ReleaseDefinitionQueryOrder))
24
- .default("NameAscending")
25
- .describe("Order of the results"),
26
- path: z.string().optional().describe("Path to filter release definitions"),
27
- isExactNameMatch: z.boolean().optional().default(false).describe("Whether to match the exact name of the release definition. Default is false."),
28
- tagFilter: z.array(z.string()).optional().describe("Filter by tags associated with the release definitions"),
29
- propertyFilters: z.array(z.string()).optional().describe("Filter by properties associated with the release definitions"),
30
- definitionIdFilter: z.array(z.string()).optional().describe("Filter by specific release definition IDs"),
31
- isDeleted: z.boolean().default(false).describe("Whether to include deleted release definitions. Default is false."),
32
- searchTextContainsFolderName: z.boolean().optional().describe("Whether to include folder names in the search text"),
33
- }, async ({ project, searchText, expand, artifactType, artifactSourceId, top, continuationToken, queryOrder, path, isExactNameMatch, tagFilter, propertyFilters, definitionIdFilter, isDeleted, searchTextContainsFolderName, }) => {
34
- const connection = await connectionProvider();
35
- const releaseApi = await connection.getReleaseApi();
36
- const releaseDefinitions = await releaseApi.getReleaseDefinitions(project, searchText, safeEnumConvert(ReleaseDefinitionExpands, expand), artifactType, artifactSourceId, top, continuationToken, safeEnumConvert(ReleaseDefinitionQueryOrder, queryOrder), path, isExactNameMatch, tagFilter, propertyFilters, definitionIdFilter, isDeleted, searchTextContainsFolderName);
37
- return {
38
- content: [{ type: "text", text: JSON.stringify(releaseDefinitions, null, 2) }],
39
- };
40
- });
41
- server.tool(RELEASE_TOOLS.get_releases, "Retrieves a list of releases for a given project.", {
42
- project: z.string().optional().describe("Project ID or name to get releases for"),
43
- definitionId: z.number().optional().describe("ID of the release definition to filter releases"),
44
- definitionEnvironmentId: z.number().optional().describe("ID of the definition environment to filter releases"),
45
- searchText: z.string().optional().describe("Search text to filter releases"),
46
- createdBy: z.string().optional().describe("User ID or name who created the release"),
47
- statusFilter: z
48
- .enum(getEnumKeys(ReleaseStatus))
49
- .optional()
50
- .default("Active")
51
- .describe("Status of the releases to filter (default: Active)"),
52
- environmentStatusFilter: z.number().optional().describe("Environment status to filter releases"),
53
- minCreatedTime: z.coerce
54
- .date()
55
- .optional()
56
- .default(() => {
57
- const sevenDaysAgo = new Date();
58
- sevenDaysAgo.setDate(sevenDaysAgo.getDate() - 7);
59
- return sevenDaysAgo;
60
- })
61
- .describe("Minimum created time for releases (default: 7 days ago)"),
62
- maxCreatedTime: z.coerce
63
- .date()
64
- .optional()
65
- .default(() => new Date())
66
- .describe("Maximum created time for releases (default: now)"),
67
- queryOrder: z
68
- .enum(getEnumKeys(ReleaseQueryOrder))
69
- .optional()
70
- .default("Ascending")
71
- .describe("Order in which to return releases (default: Ascending)"),
72
- top: z.number().optional().describe("Number of releases to return"),
73
- continuationToken: z.number().optional().describe("Continuation token for pagination"),
74
- expand: z
75
- .enum(getEnumKeys(ReleaseExpands))
76
- .optional()
77
- .default("None")
78
- .describe("Expand options for releases"),
79
- artifactTypeId: z.string().optional().describe("Filter releases by artifact type ID"),
80
- sourceId: z.string().optional().describe("Filter releases by artifact source ID"),
81
- artifactVersionId: z.string().optional().describe("Filter releases by artifact version ID"),
82
- sourceBranchFilter: z.string().optional().describe("Filter releases by source branch"),
83
- isDeleted: z.boolean().optional().default(false).describe("Whether to include deleted releases (default: false)"),
84
- tagFilter: z.array(z.string()).optional().describe("Filter releases by tags"),
85
- propertyFilters: z.array(z.string()).optional().describe("Filter releases by properties"),
86
- releaseIdFilter: z.array(z.number()).optional().describe("Filter by specific release IDs"),
87
- path: z.string().optional().describe("Path to filter releases"),
88
- }, async ({ project, definitionId, definitionEnvironmentId, searchText, createdBy, statusFilter, environmentStatusFilter, minCreatedTime, maxCreatedTime, queryOrder, top, continuationToken, expand, artifactTypeId, sourceId, artifactVersionId, sourceBranchFilter, isDeleted, tagFilter, propertyFilters, releaseIdFilter, path, }) => {
89
- const connection = await connectionProvider();
90
- const releaseApi = await connection.getReleaseApi();
91
- const releases = await releaseApi.getReleases(project, definitionId, definitionEnvironmentId, searchText, createdBy, safeEnumConvert(ReleaseStatus, statusFilter), environmentStatusFilter, minCreatedTime, maxCreatedTime, safeEnumConvert(ReleaseQueryOrder, queryOrder), top, continuationToken, safeEnumConvert(ReleaseExpands, expand), artifactTypeId, sourceId, artifactVersionId, sourceBranchFilter, isDeleted, tagFilter, propertyFilters, releaseIdFilter, path);
92
- return {
93
- content: [{ type: "text", text: JSON.stringify(releases, null, 2) }],
94
- };
95
- });
96
- }
97
- export { RELEASE_TOOLS, configureReleaseTools };