triggerBuild

Instructions

Implementation Reference

• src/tools/build-management.js:16-94 (handler)

  The primary handler function that executes the tool logic: triggers a Jenkins job build, handles parameters (string/file), constructs FormData for API POST, extracts queue ID from response.

  export async function triggerBuild(client, args) {
  	const { jobFullName, parameters = {} } = args;
  	if (!jobFullName) return failure("triggerBuild", "jobFullName is required");
  	const jobPath = encodeURIComponent(jobFullName).replace(/%2F/g, "/");
  	const allowAbsolute = process.env.ALLOW_ABSOLUTE_FILE_PARAMS === "1";
  
  	try {
  		const form = new FormData();
  		const jsonParams = { parameter: [] };
  		let fileIndex = 0;
  
  		for (const [key, value] of Object.entries(parameters)) {
  			if (typeof value === "string") {
  				const potentialPath = value;
  				const isAbsolute = path.isAbsolute(potentialPath);
  				const withinCwd =
  					!isAbsolute || potentialPath.startsWith(process.cwd());
  				const exists =
  					withinCwd &&
  					fs.existsSync(potentialPath) &&
  					fs.statSync(potentialPath).isFile();
  
  				if (exists && (!isAbsolute || allowAbsolute)) {
  					const fileFieldName = `file${fileIndex}`;
  					form.append(
  						fileFieldName,
  						fs.createReadStream(potentialPath),
  						path.basename(potentialPath)
  					);
  					jsonParams.parameter.push({
  						name: key,
  						file: fileFieldName,
  					});
  					fileIndex++;
  					continue;
  				} else if (isAbsolute && !allowAbsolute && exists) {
  					return failure(
  						"triggerBuild",
  						`Absolute file paths are not allowed: ${potentialPath}. Set ALLOW_ABSOLUTE_FILE_PARAMS=1 to override.`
  					);
  				}
  			}
  
  			// Regular parameter fallback
  			jsonParams.parameter.push({ name: key, value: String(value) });
  		}
  
  		form.append("json", JSON.stringify(jsonParams));
  
  		const response = await client.post(
  			`${client.baseUrl}/job/${jobPath}/build`,
  			form,
  			{
  				headers: form.getHeaders(),
  				maxContentLength: Infinity,
  				maxBodyLength: Infinity,
  			}
  		);
  
  		if (response.status >= 200 && response.status < 300) {
  			const location =
  				response.headers["location"] || response.headers["Location"];
  			const queueId = location?.match(/queue\/item\/(\d+)/)?.[1] || null;
  			return success("triggerBuild", {
  				message: `Build triggered successfully for ${jobFullName}`,
  				queueUrl: location || null,
  				queueId,
  				statusCode: response.status,
  			});
  		}
  		return failure(
  			"triggerBuild",
  			`Build trigger returned status ${response.status}`,
  			{ statusCode: response.status, data: response.data }
  		);
  	} catch (error) {
  		return formatError(error, "triggerBuild");
  	}
  }

• src/tools/index.js:33-47 (schema)

  Input schema for the triggerBuild tool, specifying jobFullName (required string) and parameters (object with additional properties for flexibility).

  inputSchema: {
  	type: "object",
  	properties: {
  		jobFullName: {
  			type: "string",
  			description: 'Jenkins job name (e.g., "PlaywrightBDD")',
  		},
  		parameters: {
  			type: "object",
  			description: "Build parameters including file paths",
  			additionalProperties: true,
  		},
  	},
  	required: ["jobFullName", "parameters"],
  },

• src/tools/index.js:29-49 (registration)

  Tool registration in the central toolRegistry object, defining name, description, inputSchema, and references the handler function.

  triggerBuild: {
  	name: "triggerBuild",
  	description:
  		"Trigger a Jenkins job build with file and regular parameters",
  	inputSchema: {
  		type: "object",
  		properties: {
  			jobFullName: {
  				type: "string",
  				description: 'Jenkins job name (e.g., "PlaywrightBDD")',
  			},
  			parameters: {
  				type: "object",
  				description: "Build parameters including file paths",
  				additionalProperties: true,
  			},
  		},
  		required: ["jobFullName", "parameters"],
  	},
  	handler: triggerBuild,
  },