Skip to content

Create dedicated Cause for MCP #84

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+28 −2
Open

Create dedicated Cause for MCP #84

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2c7d8e8
Create dedicated Cause for MCP
batmat Oct 21, 2025
4a1d91a
Also keep the user that triggered the MCP call
batmat Oct 22, 2025
6200431
Fix null safety issue
batmat Oct 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 28 additions & 2 deletions src/main/java/io/jenkins/plugins/mcp/server/extensions/DefaultMcpServer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,33 @@ public Job getJob(
return Jenkins.get().getItemByFullName(jobFullName, Job.class);
}

/**
* A {@link Cause} that indicates a Jenkins build was triggered via MCP call.
* <p>
* This is useful for the end user to understand that the call was trigger through this plugin's code
* and not some manual user intervention.</p>
* <p>And among others, it allows plugins like
* <a href="https://plugins.jenkins.io/buildtriggerbadge/">...</a> to offer custom badges</p>
*
* @see #triggerBuild(String, Map)
*/
public static class MCPCause extends Cause {
private final String userId;

public MCPCause() {
User currentUser = User.current();
this.userId = currentUser != null ? currentUser.getId() : null;
}

@Override
public String getShortDescription() {
if (userId != null) {
return "Triggered via MCP Server by " + userId;
}
return "Triggered via MCP Server";
}
}

@Tool(description = "Trigger a build for a Jenkins job") // keep the default value for destructive (true)
public boolean triggerBuild(
@ToolParam(description = "Full path of the Jenkins job (e.g., 'folder/job-name')") String jobFullName,
Expand All @@ -93,8 +120,7 @@ public boolean triggerBuild(

if (job != null) {
job.checkPermission(Item.BUILD);
Cause.UserIdCause userIdCause = new Cause.UserIdCause();
CauseAction action = new CauseAction(userIdCause);
CauseAction action = new CauseAction(new MCPCause());
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could be even more simple :)

            Cause.UserIdCause userIdCause = new Cause.UserIdCause();
            CauseAction action = new CauseAction(userIdCause){
                @Override
                public String getShortDescription() {
                    if (userIdCause.getUserId() != null) {
                        return "Triggered via MCP Server by " + userIdCause.getUserId();
                    }
                    return "Triggered by MCP Server";
                }
            };

Bear in mind getShortDescription is deprecated so if use by other plugins it may change (not used anymore) in the future.

if (job.isParameterized() && job instanceof Job j) {
ParametersDefinitionProperty parametersDefinition =
(ParametersDefinitionProperty) j.getProperty(ParametersDefinitionProperty.class);
Expand Down
Loading