add comment

ashwin-ant · ashwin-ant · commit 18b51d4eddd7 · 2025-05-12T09:12:00.000-07:00
diff --git a/pkg/github/repositories.go b/pkg/github/repositories.go
@@ -557,6 +557,11 @@ func ForkRepository(getClient GetClientFn, t translations.TranslationHelperFunc)
 }
 
 // DeleteFile creates a tool to delete a file in a GitHub repository.
+// This tool uses a more roundabout way of deleting a file than just using the client.Repositories.DeleteFile.
+// This is because REST file deletion endpoint (and client.Repositories.DeleteFile) don't add commit signing to the deletion commit, 
+// unlike how the endpoint backing the create_or_update_files tool does. This appears to be a quirk of the API. 
+// The approach implemented here gets automatic commit signing when used with either the github-actions user or as an app, 
+// both of which suit an LLM well.
 func DeleteFile(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc) {
 	return mcp.NewTool("delete_file",
 			mcp.WithDescription(t("TOOL_DELETE_FILE_DESCRIPTION", "Delete a file from a GitHub repository")),
