Rename workflowId to workflow_file

joshmgross · joshmgross · commit 034621bddc70 · 2025-04-15T18:40:59.000-04:00
diff --git a/README.md b/README.md
@@ -444,7 +444,7 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
 
   - `owner`: Repository owner (string, required)
   - `repo`: Repository name (string, required)
-  - `workflowId`: Workflow ID or filename (string, required)
+  - `workflow_file`: Workflow ID or filename (string, required)
   - `ref`: Git reference (branch or tag name) (string, required)
   - `inputs`: Workflow inputs (object, optional)
 
diff --git a/pkg/github/actions.go b/pkg/github/actions.go
@@ -23,9 +23,9 @@ func RunWorkflow(getClient GetClientFn, t translations.TranslationHelperFunc) (t
 				mcp.Required(),
 				mcp.Description("Repository name"),
 			),
-			mcp.WithString("workflowId",
+			mcp.WithString("workflow_file",
 				mcp.Required(),
-				mcp.Description("The ID of the workflow. You can also pass the workflow file name as a string."),
+				mcp.Description("The workflow file name or ID of the workflow entity."),
 			),
 			mcp.WithString("ref",
 				mcp.Required(),
@@ -44,7 +44,7 @@ func RunWorkflow(getClient GetClientFn, t translations.TranslationHelperFunc) (t
 			if err != nil {
 				return mcp.NewToolResultError(err.Error()), nil
 			}
-			workflowID, err := requiredParam[string](request, "workflowId")
+			workflowFileName, err := requiredParam[string](request, "workflow_file")
 			if err != nil {
 				return mcp.NewToolResultError(err.Error()), nil
 			}
@@ -76,7 +76,7 @@ func RunWorkflow(getClient GetClientFn, t translations.TranslationHelperFunc) (t
 				return nil, fmt.Errorf("failed to get GitHub client: %w", err)
 			}
 
-			resp, err := client.Actions.CreateWorkflowDispatchEventByFileName(ctx, owner, repo, workflowID, event)
+			resp, err := client.Actions.CreateWorkflowDispatchEventByFileName(ctx, owner, repo, workflowFileName, event)
 			if err != nil {
 				return nil, fmt.Errorf("failed to trigger workflow: %w", err)
 			}
diff --git a/pkg/github/actions_test.go b/pkg/github/actions_test.go
@@ -22,10 +22,10 @@ func Test_RunWorkflow(t *testing.T) {
 	assert.NotEmpty(t, tool.Description)
 	assert.Contains(t, tool.InputSchema.Properties, "owner")
 	assert.Contains(t, tool.InputSchema.Properties, "repo")
-	assert.Contains(t, tool.InputSchema.Properties, "workflowId")
+	assert.Contains(t, tool.InputSchema.Properties, "workflow_file")
 	assert.Contains(t, tool.InputSchema.Properties, "ref")
 	assert.Contains(t, tool.InputSchema.Properties, "inputs")
-	assert.ElementsMatch(t, tool.InputSchema.Required, []string{"owner", "repo", "workflowId", "ref"})
+	assert.ElementsMatch(t, tool.InputSchema.Required, []string{"owner", "repo", "workflow_file", "ref"})
 
 	tests := []struct {
 		name           string
@@ -45,10 +45,10 @@ func Test_RunWorkflow(t *testing.T) {
 				),
 			),
 			requestArgs: map[string]any{
-				"owner":      "owner",
-				"repo":       "repo",
-				"workflowId": "workflow_id",
-				"ref":        "main",
+				"owner":         "owner",
+				"repo":          "repo",
+				"workflow_file": "main.yaml",
+				"ref":           "main",
 				"inputs": map[string]any{
 					"input1": "value1",
 					"input2": "value2",
@@ -60,9 +60,9 @@ func Test_RunWorkflow(t *testing.T) {
 			name:         "missing required parameter",
 			mockedClient: mock.NewMockedHTTPClient(),
 			requestArgs: map[string]any{
-				"owner":      "owner",
-				"repo":       "repo",
-				"workflowId": "main.yaml",
+				"owner":         "owner",
+				"repo":          "repo",
+				"workflow_file": "main.yaml",
 				// missing ref
 			},
 			expectError:    true,
